3 * File for Parser and related classes
10 require_once( 'Sanitizer.php' );
11 require_once( 'HttpFunctions.php' );
14 * Update this version number when the ParserOutput format
15 * changes in an incompatible way, so the parser cache
16 * can automatically discard old data.
18 define( 'MW_PARSER_VERSION', '1.6.0' );
21 * Variable substitution O(N^2) attack
23 * Without countermeasures, it would be possible to attack the parser by saving
24 * a page filled with a large number of inclusions of large pages. The size of
25 * the generated page would be proportional to the square of the input size.
26 * Hence, we limit the number of inclusions of any given page, thus bringing any
27 * attack back to O(N).
30 define( 'MAX_INCLUDE_REPEAT', 100 );
31 define( 'MAX_INCLUDE_SIZE', 1000000 ); // 1 Million
33 define( 'RLH_FOR_UPDATE', 1 );
35 # Allowed values for $mOutputType
36 define( 'OT_HTML', 1 );
37 define( 'OT_WIKI', 2 );
38 define( 'OT_MSG' , 3 );
40 # string parameter for extractTags which will cause it
41 # to strip HTML comments in addition to regular
42 # <XML>-style tags. This should not be anything we
43 # may want to use in wikisyntax
44 define( 'STRIP_COMMENTS', 'HTMLCommentStrip' );
46 # Constants needed for external link processing
47 define( 'HTTP_PROTOCOLS', 'http:\/\/|https:\/\/' );
48 # Everything except bracket, space, or control characters
49 define( 'EXT_LINK_URL_CLASS', '[^][<>"\\x00-\\x20\\x7F]' );
51 define( 'EXT_LINK_TEXT_CLASS', '[^\]\\x00-\\x1F\\x7F]' );
52 define( 'EXT_IMAGE_FNAME_CLASS', '[A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]' );
53 define( 'EXT_IMAGE_EXTENSIONS', 'gif|png|jpg|jpeg' );
54 define( 'EXT_LINK_BRACKETED', '/\[(\b(' . wfUrlProtocols() . ')'.EXT_LINK_URL_CLASS
.'+) *('.EXT_LINK_TEXT_CLASS
.'*?)\]/S' );
55 define( 'EXT_IMAGE_REGEX',
56 '/^('.HTTP_PROTOCOLS
.')'. # Protocol
57 '('.EXT_LINK_URL_CLASS
.'+)\\/'. # Hostname and path
58 '('.EXT_IMAGE_FNAME_CLASS
.'+)\\.((?i)'.EXT_IMAGE_EXTENSIONS
.')$/S' # Filename
64 * Processes wiki markup
67 * There are three main entry points into the Parser class:
69 * produces HTML output
71 * produces altered wiki markup.
73 * performs brace substitution on MediaWiki messages
76 * objects: $wgLang, $wgContLang
78 * NOT $wgArticle, $wgUser or $wgTitle. Keep them away!
81 * $wgUseTex*, $wgUseDynamicDates*, $wgInterwikiMagic*,
82 * $wgNamespacesWithSubpages, $wgAllowExternalImages*,
83 * $wgLocaltimezone, $wgAllowSpecialInclusion*
85 * * only within ParserOptions
98 # Cleared with clearState():
99 var $mOutput, $mAutonumber, $mDTopen, $mStripState = array();
100 var $mVariables, $mIncludeCount, $mArgStack, $mLastSection, $mInPre;
101 var $mInterwikiLinkHolders, $mLinkHolders, $mUniqPrefix;
102 var $mTemplates, // cache of already loaded templates, avoids
103 // multiple SQL queries for the same string
104 $mTemplatePath; // stores an unsorted hash of all the templates already loaded
105 // in this path. Used for loop detection.
108 # These are variables reset at least once per parse regardless of $clearState
109 var $mOptions, // ParserOptions object
110 $mTitle, // Title context, used for self-link rendering and similar things
111 $mOutputType, // Output type, one of the OT_xxx constants
112 $mRevisionId; // ID to display in {{REVISIONID}} tags
122 $this->mTagHooks
= array();
131 function clearState() {
132 $this->mOutput
= new ParserOutput
;
133 $this->mAutonumber
= 0;
134 $this->mLastSection
= '';
135 $this->mDTopen
= false;
136 $this->mVariables
= false;
137 $this->mIncludeCount
= array();
138 $this->mStripState
= array();
139 $this->mArgStack
= array();
140 $this->mInPre
= false;
141 $this->mInterwikiLinkHolders
= array(
145 $this->mLinkHolders
= array(
146 'namespaces' => array(),
148 'queries' => array(),
152 $this->mRevisionId
= null;
153 $this->mUniqPrefix
= 'UNIQ' . Parser
::getRandomString();
155 # Clear these on every parse, bug 4549
156 $this->mTemplates
= array();
157 $this->mTemplatePath
= array();
159 wfRunHooks( 'ParserClearState', array( &$this ) );
163 * Accessor for mUniqPrefix.
167 function UniqPrefix() {
168 return $this->mUniqPrefix
;
172 * Convert wikitext to HTML
173 * Do not call this function recursively.
176 * @param string $text Text we want to parse
177 * @param Title &$title A title object
178 * @param array $options
179 * @param boolean $linestart
180 * @param boolean $clearState
181 * @param int $revid number to pass in {{REVISIONID}}
182 * @return ParserOutput a ParserOutput
184 function parse( $text, &$title, $options, $linestart = true, $clearState = true, $revid = null ) {
186 * First pass--just handle <nowiki> sections, pass the rest off
187 * to internalParse() which does all the real work.
190 global $wgUseTidy, $wgAlwaysUseTidy, $wgContLang;
191 $fname = 'Parser::parse';
192 wfProfileIn( $fname );
198 $this->mOptions
= $options;
199 $this->mTitle
=& $title;
200 $this->mRevisionId
= $revid;
201 $this->mOutputType
= OT_HTML
;
203 $this->mStripState
= NULL;
205 //$text = $this->strip( $text, $this->mStripState );
206 // VOODOO MAGIC FIX! Sometimes the above segfaults in PHP5.
207 $x =& $this->mStripState
;
209 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$x ) );
210 $text = $this->strip( $text, $x );
211 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$x ) );
213 # Hook to suspend the parser in this state
214 if ( !wfRunHooks( 'ParserBeforeInternalParse', array( &$this, &$text, &$x ) ) ) {
215 wfProfileOut( $fname );
219 $text = $this->internalParse( $text );
221 $text = $this->unstrip( $text, $this->mStripState
);
223 # Clean up special characters, only run once, next-to-last before doBlockLevels
225 # french spaces, last one Guillemet-left
226 # only if there is something before the space
227 '/(.) (?=\\?|:|;|!|\\302\\273)/' => '\\1 \\2',
228 # french spaces, Guillemet-right
229 '/(\\302\\253) /' => '\\1 ',
230 '/<center *>(.*)<\\/center *>/i' => '<div class="center">\\1</div>',
232 $text = preg_replace( array_keys($fixtags), array_values($fixtags), $text );
235 $text = $this->doBlockLevels( $text, $linestart );
237 $this->replaceLinkHolders( $text );
239 # the position of the parserConvert() call should not be changed. it
240 # assumes that the links are all replaced and the only thing left
241 # is the <nowiki> mark.
242 # Side-effects: this calls $this->mOutput->setTitleText()
243 $text = $wgContLang->parserConvert( $text, $this );
245 $text = $this->unstripNoWiki( $text, $this->mStripState
);
247 wfRunHooks( 'ParserBeforeTidy', array( &$this, &$text ) );
249 $text = Sanitizer
::normalizeCharReferences( $text );
251 if (($wgUseTidy and $this->mOptions
->mTidy
) or $wgAlwaysUseTidy) {
252 $text = Parser
::tidy($text);
254 # attempt to sanitize at least some nesting problems
255 # (bug #2702 and quite a few others)
257 # ''Something [http://www.cool.com cool''] -->
258 # <i>Something</i><a href="http://www.cool.com"..><i>cool></i></a>
259 '/(<([bi])>)(<([bi])>)?([^<]*)(<\/?a[^<]*>)([^<]*)(<\/\\4>)?(<\/\\2>)/' =>
260 '\\1\\3\\5\\8\\9\\6\\1\\3\\7\\8\\9',
261 # fix up an anchor inside another anchor, only
262 # at least for a single single nested link (bug 3695)
263 '/(<a[^>]+>)([^<]*)(<a[^>]+>[^<]*)<\/a>(.*)<\/a>/' =>
264 '\\1\\2</a>\\3</a>\\1\\4</a>',
265 # fix div inside inline elements- doBlockLevels won't wrap a line which
266 # contains a div, so fix it up here; replace
267 # div with escaped text
268 '/(<([aib]) [^>]+>)([^<]*)(<div([^>]*)>)(.*)(<\/div>)([^<]*)(<\/\\2>)/' =>
269 '\\1\\3<div\\5>\\6</div>\\8\\9',
270 # remove empty italic or bold tag pairs, some
271 # introduced by rules above
272 '/<([bi])><\/\\1>/' => ''
275 $text = preg_replace(
276 array_keys( $tidyregs ),
277 array_values( $tidyregs ),
281 wfRunHooks( 'ParserAfterTidy', array( &$this, &$text ) );
283 $this->mOutput
->setText( $text );
284 wfProfileOut( $fname );
286 return $this->mOutput
;
290 * Get a random string
295 function getRandomString() {
296 return dechex(mt_rand(0, 0x7fffffff)) . dechex(mt_rand(0, 0x7fffffff));
299 function &getTitle() { return $this->mTitle
; }
300 function getOptions() { return $this->mOptions
; }
303 * Replaces all occurrences of <$tag>content</$tag> in the text
304 * with a random marker and returns the new text. the output parameter
305 * $content will be an associative array filled with data on the form
306 * $unique_marker => content.
308 * If $content is already set, the additional entries will be appended
309 * If $tag is set to STRIP_COMMENTS, the function will extract
310 * <!-- HTML comments -->
315 function extractTagsAndParams($tag, $text, &$content, &$tags, &$params, $uniq_prefix = ''){
316 $rnd = $uniq_prefix . '-' . $tag . Parser
::getRandomString();
331 if( $tag == STRIP_COMMENTS
) {
332 $start = '/<!--()()/';
335 $start = "/<$tag(\\s+[^\\/>]*|\\s*)(\\/?)>/i";
336 $end = "/<\\/$tag\\s*>/i";
339 while ( '' != $text ) {
340 $p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE
);
342 if( count( $p ) < 4 ) {
349 $marker = $rnd . sprintf('%08X', $n++
);
350 $stripped .= $marker;
352 $tags[$marker] = "<$tag$attributes$empty>";
353 $params[$marker] = Sanitizer
::decodeTagAttributes( $attributes );
355 if ( $empty === '/' ) {
356 // Empty element tag, <tag />
357 $content[$marker] = null;
360 $q = preg_split( $end, $inside, 2 );
361 $content[$marker] = $q[0];
362 if( count( $q ) < 2 ) {
363 # No end tag -- let it run out to the end of the text.
374 * Wrapper function for extractTagsAndParams
375 * for cases where $tags and $params isn't needed
376 * i.e. where tags will never have params, like <nowiki>
381 function extractTags( $tag, $text, &$content, $uniq_prefix = '' ) {
382 $dummy_tags = array();
383 $dummy_params = array();
385 return Parser
::extractTagsAndParams( $tag, $text, $content,
386 $dummy_tags, $dummy_params, $uniq_prefix );
390 * Strips and renders nowiki, pre, math, hiero
391 * If $render is set, performs necessary rendering operations on plugins
392 * Returns the text, and fills an array with data needed in unstrip()
393 * If the $state is already a valid strip state, it adds to the state
395 * @param bool $stripcomments when set, HTML comments <!-- like this -->
396 * will be stripped in addition to other tags. This is important
397 * for section editing, where these comments cause confusion when
398 * counting the sections in the wikisource
402 function strip( $text, &$state, $stripcomments = false ) {
403 $render = ($this->mOutputType
== OT_HTML
);
404 $html_content = array();
405 $nowiki_content = array();
406 $math_content = array();
407 $pre_content = array();
408 $comment_content = array();
409 $ext_content = array();
411 $ext_params = array();
412 $gallery_content = array();
414 # Replace any instances of the placeholders
415 $uniq_prefix = $this->mUniqPrefix
;
416 #$text = str_replace( $uniq_prefix, wfHtmlEscapeFirst( $uniq_prefix ), $text );
421 $text = Parser
::extractTags('html', $text, $html_content, $uniq_prefix);
422 foreach( $html_content as $marker => $content ) {
424 # Raw and unchecked for validity.
425 $html_content[$marker] = $content;
427 $html_content[$marker] = '<html>'.$content.'</html>';
433 $text = Parser
::extractTags('nowiki', $text, $nowiki_content, $uniq_prefix);
434 foreach( $nowiki_content as $marker => $content ) {
436 $nowiki_content[$marker] = wfEscapeHTMLTagsOnly( $content );
438 $nowiki_content[$marker] = '<nowiki>'.$content.'</nowiki>';
443 if( $this->mOptions
->getUseTeX() ) {
444 $text = Parser
::extractTags('math', $text, $math_content, $uniq_prefix);
445 foreach( $math_content as $marker => $content ){
447 $math_content[$marker] = renderMath( $content );
449 $math_content[$marker] = '<math>'.$content.'</math>';
455 $text = Parser
::extractTags('pre', $text, $pre_content, $uniq_prefix);
456 foreach( $pre_content as $marker => $content ){
458 $pre_content[$marker] = '<pre>' . wfEscapeHTMLTagsOnly( $content ) . '</pre>';
460 $pre_content[$marker] = '<pre>'.$content.'</pre>';
465 $text = Parser
::extractTags('gallery', $text, $gallery_content, $uniq_prefix);
466 foreach( $gallery_content as $marker => $content ) {
467 require_once( 'ImageGallery.php' );
469 $gallery_content[$marker] = $this->renderImageGallery( $content );
471 $gallery_content[$marker] = '<gallery>'.$content.'</gallery>';
477 $text = Parser
::extractTags(STRIP_COMMENTS
, $text, $comment_content, $uniq_prefix);
478 foreach( $comment_content as $marker => $content ){
479 $comment_content[$marker] = '<!--'.$content.'-->';
484 foreach ( $this->mTagHooks
as $tag => $callback ) {
485 $ext_content[$tag] = array();
486 $text = Parser
::extractTagsAndParams( $tag, $text, $ext_content[$tag],
487 $ext_tags[$tag], $ext_params[$tag], $uniq_prefix );
488 foreach( $ext_content[$tag] as $marker => $content ) {
489 $full_tag = $ext_tags[$tag][$marker];
490 $params = $ext_params[$tag][$marker];
492 $ext_content[$tag][$marker] = call_user_func_array( $callback, array( $content, $params, &$this ) );
494 if ( is_null( $content ) ) {
496 $ext_content[$tag][$marker] = $full_tag;
498 $ext_content[$tag][$marker] = "$full_tag$content</$tag>";
504 # Merge state with the pre-existing state, if there is one
506 $state['html'] = $state['html'] +
$html_content;
507 $state['nowiki'] = $state['nowiki'] +
$nowiki_content;
508 $state['math'] = $state['math'] +
$math_content;
509 $state['pre'] = $state['pre'] +
$pre_content;
510 $state['gallery'] = $state['gallery'] +
$gallery_content;
511 $state['comment'] = $state['comment'] +
$comment_content;
513 foreach( $ext_content as $tag => $array ) {
514 if ( array_key_exists( $tag, $state ) ) {
515 $state[$tag] = $state[$tag] +
$array;
520 'html' => $html_content,
521 'nowiki' => $nowiki_content,
522 'math' => $math_content,
523 'pre' => $pre_content,
524 'gallery' => $gallery_content,
525 'comment' => $comment_content,
532 * restores pre, math, and hiero removed by strip()
534 * always call unstripNoWiki() after this one
537 function unstrip( $text, &$state ) {
538 if ( !is_array( $state ) ) {
542 # Must expand in reverse order, otherwise nested tags will be corrupted
543 foreach( array_reverse( $state, true ) as $tag => $contentDict ) {
544 if( $tag != 'nowiki' && $tag != 'html' ) {
545 foreach( array_reverse( $contentDict, true ) as $uniq => $content ) {
546 $text = str_replace( $uniq, $content, $text );
555 * always call this after unstrip() to preserve the order
559 function unstripNoWiki( $text, &$state ) {
560 if ( !is_array( $state ) ) {
564 # Must expand in reverse order, otherwise nested tags will be corrupted
565 for ( $content = end($state['nowiki']); $content !== false; $content = prev( $state['nowiki'] ) ) {
566 $text = str_replace( key( $state['nowiki'] ), $content, $text );
571 for ( $content = end($state['html']); $content !== false; $content = prev( $state['html'] ) ) {
572 $text = str_replace( key( $state['html'] ), $content, $text );
580 * Add an item to the strip state
581 * Returns the unique tag which must be inserted into the stripped text
582 * The tag will be replaced with the original text in unstrip()
586 function insertStripItem( $text, &$state ) {
587 $rnd = $this->mUniqPrefix
. '-item' . Parser
::getRandomString();
594 'comment' => array(),
595 'gallery' => array(),
598 $state['item'][$rnd] = $text;
603 * Interface with html tidy, used if $wgUseTidy = true.
604 * If tidy isn't able to correct the markup, the original will be
605 * returned in all its glory with a warning comment appended.
607 * Either the external tidy program or the in-process tidy extension
608 * will be used depending on availability. Override the default
609 * $wgTidyInternal setting to disable the internal if it's not working.
611 * @param string $text Hideous HTML input
612 * @return string Corrected HTML output
616 function tidy( $text ) {
617 global $wgTidyInternal;
618 $wrappedtext = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"'.
619 ' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>'.
620 '<head><title>test</title></head><body>'.$text.'</body></html>';
621 if( $wgTidyInternal ) {
622 $correctedtext = Parser
::internalTidy( $wrappedtext );
624 $correctedtext = Parser
::externalTidy( $wrappedtext );
626 if( is_null( $correctedtext ) ) {
627 wfDebug( "Tidy error detected!\n" );
628 return $text . "\n<!-- Tidy found serious XHTML errors -->\n";
630 return $correctedtext;
634 * Spawn an external HTML tidy process and get corrected markup back from it.
639 function externalTidy( $text ) {
640 global $wgTidyConf, $wgTidyBin, $wgTidyOpts;
641 $fname = 'Parser::externalTidy';
642 wfProfileIn( $fname );
647 $descriptorspec = array(
648 0 => array('pipe', 'r'),
649 1 => array('pipe', 'w'),
650 2 => array('file', '/dev/null', 'a')
653 $process = proc_open("$wgTidyBin -config $wgTidyConf $wgTidyOpts$opts", $descriptorspec, $pipes);
654 if (is_resource($process)) {
655 // Theoretically, this style of communication could cause a deadlock
656 // here. If the stdout buffer fills up, then writes to stdin could
657 // block. This doesn't appear to happen with tidy, because tidy only
658 // writes to stdout after it's finished reading from stdin. Search
659 // for tidyParseStdin and tidySaveStdout in console/tidy.c
660 fwrite($pipes[0], $text);
662 while (!feof($pipes[1])) {
663 $cleansource .= fgets($pipes[1], 1024);
666 proc_close($process);
669 wfProfileOut( $fname );
671 if( $cleansource == '' && $text != '') {
672 // Some kind of error happened, so we couldn't get the corrected text.
673 // Just give up; we'll use the source text and append a warning.
681 * Use the HTML tidy PECL extension to use the tidy library in-process,
682 * saving the overhead of spawning a new process. Currently written to
683 * the PHP 4.3.x version of the extension, may not work on PHP 5.
685 * 'pear install tidy' should be able to compile the extension module.
690 function internalTidy( $text ) {
692 $fname = 'Parser::internalTidy';
693 wfProfileIn( $fname );
695 tidy_load_config( $wgTidyConf );
696 tidy_set_encoding( 'utf8' );
697 tidy_parse_string( $text );
699 if( tidy_get_status() == 2 ) {
700 // 2 is magic number for fatal error
701 // http://www.php.net/manual/en/function.tidy-get-status.php
704 $cleansource = tidy_get_output();
706 wfProfileOut( $fname );
711 * parse the wiki syntax used to render tables
715 function doTableStuff ( $t ) {
716 $fname = 'Parser::doTableStuff';
717 wfProfileIn( $fname );
719 $t = explode ( "\n" , $t ) ;
720 $td = array () ; # Is currently a td tag open?
721 $ltd = array () ; # Was it TD or TH?
722 $tr = array () ; # Is currently a tr tag open?
723 $ltr = array () ; # tr attributes
724 $has_opened_tr = array(); # Did this table open a <tr> element?
725 $indent_level = 0; # indent level of the table
726 foreach ( $t AS $k => $x )
729 $fc = substr ( $x , 0 , 1 ) ;
730 if ( preg_match( '/^(:*)\{\|(.*)$/', $x, $matches ) ) {
731 $indent_level = strlen( $matches[1] );
733 $attributes = $this->unstripForHTML( $matches[2] );
735 $t[$k] = str_repeat( '<dl><dd>', $indent_level ) .
736 '<table' . Sanitizer
::fixTagAttributes ( $attributes, 'table' ) . '>' ;
737 array_push ( $td , false ) ;
738 array_push ( $ltd , '' ) ;
739 array_push ( $tr , false ) ;
740 array_push ( $ltr , '' ) ;
741 array_push ( $has_opened_tr, false );
743 else if ( count ( $td ) == 0 ) { } # Don't do any of the following
744 else if ( '|}' == substr ( $x , 0 , 2 ) ) {
745 $z = "</table>" . substr ( $x , 2);
746 $l = array_pop ( $ltd ) ;
747 if ( !array_pop ( $has_opened_tr ) ) $z = "<tr><td></td></tr>" . $z ;
748 if ( array_pop ( $tr ) ) $z = '</tr>' . $z ;
749 if ( array_pop ( $td ) ) $z = '</'.$l.'>' . $z ;
751 $t[$k] = $z . str_repeat( '</dd></dl>', $indent_level );
753 else if ( '|-' == substr ( $x , 0 , 2 ) ) { # Allows for |---------------
754 $x = substr ( $x , 1 ) ;
755 while ( $x != '' && substr ( $x , 0 , 1 ) == '-' ) $x = substr ( $x , 1 ) ;
757 $l = array_pop ( $ltd ) ;
758 array_pop ( $has_opened_tr );
759 array_push ( $has_opened_tr , true ) ;
760 if ( array_pop ( $tr ) ) $z = '</tr>' . $z ;
761 if ( array_pop ( $td ) ) $z = '</'.$l.'>' . $z ;
764 array_push ( $tr , false ) ;
765 array_push ( $td , false ) ;
766 array_push ( $ltd , '' ) ;
767 $attributes = $this->unstripForHTML( $x );
768 array_push ( $ltr , Sanitizer
::fixTagAttributes ( $attributes, 'tr' ) ) ;
770 else if ( '|' == $fc ||
'!' == $fc ||
'|+' == substr ( $x , 0 , 2 ) ) { # Caption
772 if ( '|+' == substr ( $x , 0 , 2 ) ) {
774 $x = substr ( $x , 1 ) ;
776 $after = substr ( $x , 1 ) ;
777 if ( $fc == '!' ) $after = str_replace ( '!!' , '||' , $after ) ;
778 $after = explode ( '||' , $after ) ;
781 # Loop through each table cell
782 foreach ( $after AS $theline )
787 $tra = array_pop ( $ltr ) ;
788 if ( !array_pop ( $tr ) ) $z = '<tr'.$tra.">\n" ;
789 array_push ( $tr , true ) ;
790 array_push ( $ltr , '' ) ;
791 array_pop ( $has_opened_tr );
792 array_push ( $has_opened_tr , true ) ;
795 $l = array_pop ( $ltd ) ;
796 if ( array_pop ( $td ) ) $z = '</'.$l.'>' . $z ;
797 if ( $fc == '|' ) $l = 'td' ;
798 else if ( $fc == '!' ) $l = 'th' ;
799 else if ( $fc == '+' ) $l = 'caption' ;
801 array_push ( $ltd , $l ) ;
804 $y = explode ( '|' , $theline , 2 ) ;
805 # Note that a '|' inside an invalid link should not
806 # be mistaken as delimiting cell parameters
807 if ( strpos( $y[0], '[[' ) !== false ) {
808 $y = array ($theline);
810 if ( count ( $y ) == 1 )
811 $y = "{$z}<{$l}>{$y[0]}" ;
813 $attributes = $this->unstripForHTML( $y[0] );
814 $y = "{$z}<{$l}".Sanitizer
::fixTagAttributes($attributes, $l).">{$y[1]}" ;
817 array_push ( $td , true ) ;
822 # Closing open td, tr && table
823 while ( count ( $td ) > 0 )
825 $l = array_pop ( $ltd ) ;
826 if ( array_pop ( $td ) ) $t[] = '</td>' ;
827 if ( array_pop ( $tr ) ) $t[] = '</tr>' ;
828 if ( !array_pop ( $has_opened_tr ) ) $t[] = "<tr><td></td></tr>" ;
832 $t = implode ( "\n" , $t ) ;
833 # special case: don't return empty table
834 if($t == "<table>\n<tr><td></td></tr>\n</table>")
836 wfProfileOut( $fname );
841 * Helper function for parse() that transforms wiki markup into
842 * HTML. Only called for $mOutputType == OT_HTML.
846 function internalParse( $text ) {
849 $fname = 'Parser::internalParse';
850 wfProfileIn( $fname );
852 # Remove <noinclude> tags and <includeonly> sections
853 $text = strtr( $text, array( '<onlyinclude>' => '' , '</onlyinclude>' => '' ) );
854 $text = strtr( $text, array( '<noinclude>' => '', '</noinclude>' => '') );
855 $text = preg_replace( '/<includeonly>.*?<\/includeonly>/s', '', $text );
857 $text = Sanitizer
::removeHTMLtags( $text, array( &$this, 'attributeStripCallback' ) );
858 $text = $this->replaceVariables( $text, $args );
860 $text = preg_replace( '/(^|\n)-----*/', '\\1<hr />', $text );
862 $text = $this->doHeadings( $text );
863 if($this->mOptions
->getUseDynamicDates()) {
864 $df =& DateFormatter
::getInstance();
865 $text = $df->reformat( $this->mOptions
->getDateFormat(), $text );
867 $text = $this->doAllQuotes( $text );
868 $text = $this->replaceInternalLinks( $text );
869 $text = $this->replaceExternalLinks( $text );
871 # replaceInternalLinks may sometimes leave behind
872 # absolute URLs, which have to be masked to hide them from replaceExternalLinks
873 $text = str_replace($this->mUniqPrefix
."NOPARSE", "", $text);
875 $text = $this->doMagicLinks( $text );
876 $text = $this->doTableStuff( $text );
877 $text = $this->formatHeadings( $text, $isMain );
879 wfProfileOut( $fname );
884 * Replace special strings like "ISBN xxx" and "RFC xxx" with
885 * magic external links.
889 function &doMagicLinks( &$text ) {
890 $text = $this->magicISBN( $text );
891 $text = $this->magicRFC( $text, 'RFC ', 'rfcurl' );
892 $text = $this->magicRFC( $text, 'PMID ', 'pubmedurl' );
897 * Parse headers and return html
901 function doHeadings( $text ) {
902 $fname = 'Parser::doHeadings';
903 wfProfileIn( $fname );
904 for ( $i = 6; $i >= 1; --$i ) {
905 $h = str_repeat( '=', $i );
906 $text = preg_replace( "/^{$h}(.+){$h}(\\s|$)/m",
907 "<h{$i}>\\1</h{$i}>\\2", $text );
909 wfProfileOut( $fname );
914 * Replace single quotes with HTML markup
916 * @return string the altered text
918 function doAllQuotes( $text ) {
919 $fname = 'Parser::doAllQuotes';
920 wfProfileIn( $fname );
922 $lines = explode( "\n", $text );
923 foreach ( $lines as $line ) {
924 $outtext .= $this->doQuotes ( $line ) . "\n";
926 $outtext = substr($outtext, 0,-1);
927 wfProfileOut( $fname );
932 * Helper function for doAllQuotes()
935 function doQuotes( $text ) {
936 $arr = preg_split( "/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE
);
937 if ( count( $arr ) == 1 )
941 # First, do some preliminary work. This may shift some apostrophes from
942 # being mark-up to being text. It also counts the number of occurrences
943 # of bold and italics mark-ups.
947 foreach ( $arr as $r )
949 if ( ( $i %
2 ) == 1 )
951 # If there are ever four apostrophes, assume the first is supposed to
952 # be text, and the remaining three constitute mark-up for bold text.
953 if ( strlen( $arr[$i] ) == 4 )
958 # If there are more than 5 apostrophes in a row, assume they're all
959 # text except for the last 5.
960 else if ( strlen( $arr[$i] ) > 5 )
962 $arr[$i-1] .= str_repeat( "'", strlen( $arr[$i] ) - 5 );
965 # Count the number of occurrences of bold and italics mark-ups.
966 # We are not counting sequences of five apostrophes.
967 if ( strlen( $arr[$i] ) == 2 ) $numitalics++
; else
968 if ( strlen( $arr[$i] ) == 3 ) $numbold++
; else
969 if ( strlen( $arr[$i] ) == 5 ) { $numitalics++
; $numbold++
; }
974 # If there is an odd number of both bold and italics, it is likely
975 # that one of the bold ones was meant to be an apostrophe followed
976 # by italics. Which one we cannot know for certain, but it is more
977 # likely to be one that has a single-letter word before it.
978 if ( ( $numbold %
2 == 1 ) && ( $numitalics %
2 == 1 ) )
981 $firstsingleletterword = -1;
982 $firstmultiletterword = -1;
984 foreach ( $arr as $r )
986 if ( ( $i %
2 == 1 ) and ( strlen( $r ) == 3 ) )
988 $x1 = substr ($arr[$i-1], -1);
989 $x2 = substr ($arr[$i-1], -2, 1);
991 if ($firstspace == -1) $firstspace = $i;
992 } else if ($x2 == ' ') {
993 if ($firstsingleletterword == -1) $firstsingleletterword = $i;
995 if ($firstmultiletterword == -1) $firstmultiletterword = $i;
1001 # If there is a single-letter word, use it!
1002 if ($firstsingleletterword > -1)
1004 $arr [ $firstsingleletterword ] = "''";
1005 $arr [ $firstsingleletterword-1 ] .= "'";
1007 # If not, but there's a multi-letter word, use that one.
1008 else if ($firstmultiletterword > -1)
1010 $arr [ $firstmultiletterword ] = "''";
1011 $arr [ $firstmultiletterword-1 ] .= "'";
1013 # ... otherwise use the first one that has neither.
1014 # (notice that it is possible for all three to be -1 if, for example,
1015 # there is only one pentuple-apostrophe in the line)
1016 else if ($firstspace > -1)
1018 $arr [ $firstspace ] = "''";
1019 $arr [ $firstspace-1 ] .= "'";
1023 # Now let's actually convert our apostrophic mush to HTML!
1028 foreach ($arr as $r)
1032 if ($state == 'both')
1039 if (strlen ($r) == 2)
1042 { $output .= '</i>'; $state = ''; }
1043 else if ($state == 'bi')
1044 { $output .= '</i>'; $state = 'b'; }
1045 else if ($state == 'ib')
1046 { $output .= '</b></i><b>'; $state = 'b'; }
1047 else if ($state == 'both')
1048 { $output .= '<b><i>'.$buffer.'</i>'; $state = 'b'; }
1049 else # $state can be 'b' or ''
1050 { $output .= '<i>'; $state .= 'i'; }
1052 else if (strlen ($r) == 3)
1055 { $output .= '</b>'; $state = ''; }
1056 else if ($state == 'bi')
1057 { $output .= '</i></b><i>'; $state = 'i'; }
1058 else if ($state == 'ib')
1059 { $output .= '</b>'; $state = 'i'; }
1060 else if ($state == 'both')
1061 { $output .= '<i><b>'.$buffer.'</b>'; $state = 'i'; }
1062 else # $state can be 'i' or ''
1063 { $output .= '<b>'; $state .= 'b'; }
1065 else if (strlen ($r) == 5)
1068 { $output .= '</b><i>'; $state = 'i'; }
1069 else if ($state == 'i')
1070 { $output .= '</i><b>'; $state = 'b'; }
1071 else if ($state == 'bi')
1072 { $output .= '</i></b>'; $state = ''; }
1073 else if ($state == 'ib')
1074 { $output .= '</b></i>'; $state = ''; }
1075 else if ($state == 'both')
1076 { $output .= '<i><b>'.$buffer.'</b></i>'; $state = ''; }
1077 else # ($state == '')
1078 { $buffer = ''; $state = 'both'; }
1083 # Now close all remaining tags. Notice that the order is important.
1084 if ($state == 'b' ||
$state == 'ib')
1086 if ($state == 'i' ||
$state == 'bi' ||
$state == 'ib')
1090 if ($state == 'both')
1091 $output .= '<b><i>'.$buffer.'</i></b>';
1097 * Replace external links
1099 * Note: this is all very hackish and the order of execution matters a lot.
1100 * Make sure to run maintenance/parserTests.php if you change this code.
1104 function replaceExternalLinks( $text ) {
1106 $fname = 'Parser::replaceExternalLinks';
1107 wfProfileIn( $fname );
1109 $sk =& $this->mOptions
->getSkin();
1111 $bits = preg_split( EXT_LINK_BRACKETED
, $text, -1, PREG_SPLIT_DELIM_CAPTURE
);
1113 $s = $this->replaceFreeExternalLinks( array_shift( $bits ) );
1116 while ( $i<count( $bits ) ) {
1118 $protocol = $bits[$i++
];
1119 $text = $bits[$i++
];
1120 $trail = $bits[$i++
];
1122 # The characters '<' and '>' (which were escaped by
1123 # removeHTMLtags()) should not be included in
1124 # URLs, per RFC 2396.
1125 if (preg_match('/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE
)) {
1126 $text = substr($url, $m2[0][1]) . ' ' . $text;
1127 $url = substr($url, 0, $m2[0][1]);
1130 # If the link text is an image URL, replace it with an <img> tag
1131 # This happened by accident in the original parser, but some people used it extensively
1132 $img = $this->maybeMakeExternalImage( $text );
1133 if ( $img !== false ) {
1139 # Set linktype for CSS - if URL==text, link is essentially free
1140 $linktype = ($text == $url) ?
'free' : 'text';
1142 # No link text, e.g. [http://domain.tld/some.link]
1143 if ( $text == '' ) {
1144 # Autonumber if allowed
1145 if ( strpos( HTTP_PROTOCOLS
, str_replace('/','\/', $protocol) ) !== false ) {
1146 $text = '[' . ++
$this->mAutonumber
. ']';
1147 $linktype = 'autonumber';
1149 # Otherwise just use the URL
1150 $text = htmlspecialchars( $url );
1154 # Have link text, e.g. [http://domain.tld/some.link text]s
1156 list( $dtrail, $trail ) = Linker
::splitTrail( $trail );
1159 $text = $wgContLang->markNoConversion($text);
1161 # Replace & from obsolete syntax with &.
1162 # All HTML entities will be escaped by makeExternalLink()
1163 $url = str_replace( '&', '&', $url );
1165 # Process the trail (i.e. everything after this link up until start of the next link),
1166 # replacing any non-bracketed links
1167 $trail = $this->replaceFreeExternalLinks( $trail );
1169 # Use the encoded URL
1170 # This means that users can paste URLs directly into the text
1171 # Funny characters like ö aren't valid in URLs anyway
1172 # This was changed in August 2004
1173 $s .= $sk->makeExternalLink( $url, $text, false, $linktype ) . $dtrail . $trail;
1175 # Register link in the output object.
1176 # Replace unnecessary URL escape codes with the referenced character
1177 # This prevents spammers from hiding links from the filters
1178 $pasteurized = Parser
::replaceUnusualEscapes( $url );
1179 $this->mOutput
->addExternalLink( $pasteurized );
1182 wfProfileOut( $fname );
1187 * Replace anything that looks like a URL with a link
1190 function replaceFreeExternalLinks( $text ) {
1192 $fname = 'Parser::replaceFreeExternalLinks';
1193 wfProfileIn( $fname );
1195 $bits = preg_split( '/(\b(?:' . wfUrlProtocols() . '))/S', $text, -1, PREG_SPLIT_DELIM_CAPTURE
);
1196 $s = array_shift( $bits );
1199 $sk =& $this->mOptions
->getSkin();
1201 while ( $i < count( $bits ) ){
1202 $protocol = $bits[$i++
];
1203 $remainder = $bits[$i++
];
1205 if ( preg_match( '/^('.EXT_LINK_URL_CLASS
.'+)(.*)$/s', $remainder, $m ) ) {
1206 # Found some characters after the protocol that look promising
1207 $url = $protocol . $m[1];
1210 # special case: handle urls as url args:
1211 # http://www.example.com/foo?=http://www.example.com/bar
1212 if(strlen($trail) == 0 &&
1214 preg_match('/^'. wfUrlProtocols() . '$/S', $bits[$i]) &&
1215 preg_match( '/^('.EXT_LINK_URL_CLASS
.'+)(.*)$/s', $bits[$i +
1], $m ))
1218 $url .= $bits[$i] . $bits[$i +
1]; # protocol, url as arg to previous link
1223 # The characters '<' and '>' (which were escaped by
1224 # removeHTMLtags()) should not be included in
1225 # URLs, per RFC 2396.
1226 if (preg_match('/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE
)) {
1227 $trail = substr($url, $m2[0][1]) . $trail;
1228 $url = substr($url, 0, $m2[0][1]);
1231 # Move trailing punctuation to $trail
1233 # If there is no left bracket, then consider right brackets fair game too
1234 if ( strpos( $url, '(' ) === false ) {
1238 $numSepChars = strspn( strrev( $url ), $sep );
1239 if ( $numSepChars ) {
1240 $trail = substr( $url, -$numSepChars ) . $trail;
1241 $url = substr( $url, 0, -$numSepChars );
1244 # Replace & from obsolete syntax with &.
1245 # All HTML entities will be escaped by makeExternalLink()
1246 # or maybeMakeExternalImage()
1247 $url = str_replace( '&', '&', $url );
1249 # Is this an external image?
1250 $text = $this->maybeMakeExternalImage( $url );
1251 if ( $text === false ) {
1252 # Not an image, make a link
1253 $text = $sk->makeExternalLink( $url, $wgContLang->markNoConversion($url), true, 'free' );
1254 # Register it in the output object...
1255 # Replace unnecessary URL escape codes with their equivalent characters
1256 $pasteurized = Parser
::replaceUnusualEscapes( $url );
1257 $this->mOutput
->addExternalLink( $pasteurized );
1259 $s .= $text . $trail;
1261 $s .= $protocol . $remainder;
1264 wfProfileOut( $fname );
1269 * Replace unusual URL escape codes with their equivalent characters
1273 * @fixme This can merge genuinely required bits in the path or query string,
1274 * breaking legit URLs. A proper fix would treat the various parts of
1275 * the URL differently; as a workaround, just use the output for
1276 * statistical records, not for actual linking/output.
1278 function replaceUnusualEscapes( $url ) {
1279 return preg_replace_callback( '/%[0-9A-Fa-f]{2}/',
1280 array( 'Parser', 'replaceUnusualEscapesCallback' ), $url );
1284 * Callback function used in replaceUnusualEscapes().
1285 * Replaces unusual URL escape codes with their equivalent character
1289 function replaceUnusualEscapesCallback( $matches ) {
1290 $char = urldecode( $matches[0] );
1291 $ord = ord( $char );
1292 // Is it an unsafe or HTTP reserved character according to RFC 1738?
1293 if ( $ord > 32 && $ord < 127 && strpos( '<>"#{}|\^~[]`;/?', $char ) === false ) {
1294 // No, shouldn't be escaped
1297 // Yes, leave it escaped
1303 * make an image if it's allowed, either through the global
1304 * option or through the exception
1307 function maybeMakeExternalImage( $url ) {
1308 $sk =& $this->mOptions
->getSkin();
1309 $imagesfrom = $this->mOptions
->getAllowExternalImagesFrom();
1310 $imagesexception = !empty($imagesfrom);
1312 if ( $this->mOptions
->getAllowExternalImages()
1313 ||
( $imagesexception && strpos( $url, $imagesfrom ) === 0 ) ) {
1314 if ( preg_match( EXT_IMAGE_REGEX
, $url ) ) {
1316 $text = $sk->makeExternalImage( htmlspecialchars( $url ) );
1323 * Process [[ ]] wikilinks
1327 function replaceInternalLinks( $s ) {
1329 static $fname = 'Parser::replaceInternalLinks' ;
1331 wfProfileIn( $fname );
1333 wfProfileIn( $fname.'-setup' );
1335 # the % is needed to support urlencoded titles as well
1336 if ( !$tc ) { $tc = Title
::legalChars() . '#%'; }
1338 $sk =& $this->mOptions
->getSkin();
1340 #split the entire text string on occurences of [[
1341 $a = explode( '[[', ' ' . $s );
1342 #get the first element (all text up to first [[), and remove the space we added
1343 $s = array_shift( $a );
1344 $s = substr( $s, 1 );
1346 # Match a link having the form [[namespace:link|alternate]]trail
1348 if ( !$e1 ) { $e1 = "/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD"; }
1349 # Match cases where there is no "]]", which might still be images
1350 static $e1_img = FALSE;
1351 if ( !$e1_img ) { $e1_img = "/^([{$tc}]+)\\|(.*)\$/sD"; }
1352 # Match the end of a line for a word that's not followed by whitespace,
1353 # e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
1354 $e2 = wfMsgForContent( 'linkprefix' );
1356 $useLinkPrefixExtension = $wgContLang->linkPrefixExtension();
1358 if( is_null( $this->mTitle
) ) {
1359 wfDebugDieBacktrace( 'nooo' );
1361 $nottalk = !$this->mTitle
->isTalkPage();
1363 if ( $useLinkPrefixExtension ) {
1364 if ( preg_match( $e2, $s, $m ) ) {
1365 $first_prefix = $m[2];
1367 $first_prefix = false;
1373 $selflink = $this->mTitle
->getPrefixedText();
1374 wfProfileOut( $fname.'-setup' );
1376 $checkVariantLink = sizeof($wgContLang->getVariants())>1;
1377 $useSubpages = $this->areSubpagesAllowed();
1379 # Loop for each link
1380 for ($k = 0; isset( $a[$k] ); $k++
) {
1382 if ( $useLinkPrefixExtension ) {
1383 wfProfileIn( $fname.'-prefixhandling' );
1384 if ( preg_match( $e2, $s, $m ) ) {
1392 $prefix = $first_prefix;
1393 $first_prefix = false;
1395 wfProfileOut( $fname.'-prefixhandling' );
1398 $might_be_img = false;
1400 if ( preg_match( $e1, $line, $m ) ) { # page with normal text or alt
1402 # If we get a ] at the beginning of $m[3] that means we have a link that's something like:
1403 # [[Image:Foo.jpg|[http://example.com desc]]] <- having three ] in a row fucks up,
1404 # the real problem is with the $e1 regex
1407 # Still some problems for cases where the ] is meant to be outside punctuation,
1408 # and no image is in sight. See bug 2095.
1410 if( $text !== '' && preg_match( "/^\](.*)/s", $m[3], $n ) ) {
1411 $text .= ']'; # so that replaceExternalLinks($text) works later
1414 # fix up urlencoded title texts
1415 if(preg_match('/%/', $m[1] )) $m[1] = urldecode($m[1]);
1417 } elseif( preg_match($e1_img, $line, $m) ) { # Invalid, but might be an image with a link in its caption
1418 $might_be_img = true;
1420 if(preg_match('/%/', $m[1] )) $m[1] = urldecode($m[1]);
1422 } else { # Invalid form; output directly
1423 $s .= $prefix . '[[' . $line ;
1427 # Don't allow internal links to pages containing
1428 # PROTO: where PROTO is a valid URL protocol; these
1429 # should be external links.
1430 if (preg_match('/^(\b(?:' . wfUrlProtocols() . '))/', $m[1])) {
1431 $s .= $prefix . '[[' . $line ;
1435 # Make subpage if necessary
1436 if( $useSubpages ) {
1437 $link = $this->maybeDoSubpageLink( $m[1], $text );
1442 $noforce = (substr($m[1], 0, 1) != ':');
1444 # Strip off leading ':'
1445 $link = substr($link, 1);
1448 $nt = Title
::newFromText( $this->unstripNoWiki($link, $this->mStripState
) );
1450 $s .= $prefix . '[[' . $line;
1454 #check other language variants of the link
1455 #if the article does not exist
1456 if( $checkVariantLink
1457 && $nt->getArticleID() == 0 ) {
1458 $wgContLang->findVariantLink($link, $nt);
1461 $ns = $nt->getNamespace();
1462 $iw = $nt->getInterWiki();
1464 if ($might_be_img) { # if this is actually an invalid link
1465 if ($ns == NS_IMAGE
&& $noforce) { #but might be an image
1467 while (isset ($a[$k+
1]) ) {
1468 #look at the next 'line' to see if we can close it there
1469 $spliced = array_splice( $a, $k +
1, 1 );
1470 $next_line = array_shift( $spliced );
1471 if( preg_match("/^(.*?]].*?)]](.*)$/sD", $next_line, $m) ) {
1472 # the first ]] closes the inner link, the second the image
1474 $text .= '[[' . $m[1];
1477 } elseif( preg_match("/^.*?]].*$/sD", $next_line, $m) ) {
1478 #if there's exactly one ]] that's fine, we'll keep looking
1479 $text .= '[[' . $m[0];
1481 #if $next_line is invalid too, we need look no further
1482 $text .= '[[' . $next_line;
1487 # we couldn't find the end of this imageLink, so output it raw
1488 #but don't ignore what might be perfectly normal links in the text we've examined
1489 $text = $this->replaceInternalLinks($text);
1490 $s .= $prefix . '[[' . $link . '|' . $text;
1491 # note: no $trail, because without an end, there *is* no trail
1494 } else { #it's not an image, so output it raw
1495 $s .= $prefix . '[[' . $link . '|' . $text;
1496 # note: no $trail, because without an end, there *is* no trail
1501 $wasblank = ( '' == $text );
1502 if( $wasblank ) $text = $link;
1505 # Link not escaped by : , create the various objects
1509 if( $iw && $this->mOptions
->getInterwikiMagic() && $nottalk && $wgContLang->getLanguageName( $iw ) ) {
1510 $this->mOutput
->addLanguageLink( $nt->getFullText() );
1511 $s = rtrim($s . "\n");
1512 $s .= trim($prefix . $trail, "\n") == '' ?
'': $prefix . $trail;
1516 if ( $ns == NS_IMAGE
) {
1517 wfProfileIn( "$fname-image" );
1518 if ( !wfIsBadImage( $nt->getDBkey() ) ) {
1519 # recursively parse links inside the image caption
1520 # actually, this will parse them in any other parameters, too,
1521 # but it might be hard to fix that, and it doesn't matter ATM
1522 $text = $this->replaceExternalLinks($text);
1523 $text = $this->replaceInternalLinks($text);
1525 # cloak any absolute URLs inside the image markup, so replaceExternalLinks() won't touch them
1526 $s .= $prefix . $this->armorLinks( $this->makeImage( $nt, $text ) ) . $trail;
1527 $this->mOutput
->addImage( $nt->getDBkey() );
1529 wfProfileOut( "$fname-image" );
1532 wfProfileOut( "$fname-image" );
1536 if ( $ns == NS_CATEGORY
) {
1537 wfProfileIn( "$fname-category" );
1538 $s = rtrim($s . "\n"); # bug 87
1541 if ( $this->mTitle
->getNamespace() == NS_CATEGORY
) {
1542 $sortkey = $this->mTitle
->getText();
1544 $sortkey = $this->mTitle
->getPrefixedText();
1549 $sortkey = Sanitizer
::decodeCharReferences( $sortkey );
1550 $sortkey = $wgContLang->convertCategoryKey( $sortkey );
1551 $this->mOutput
->addCategory( $nt->getDBkey(), $sortkey );
1554 * Strip the whitespace Category links produce, see bug 87
1555 * @todo We might want to use trim($tmp, "\n") here.
1557 $s .= trim($prefix . $trail, "\n") == '' ?
'': $prefix . $trail;
1559 wfProfileOut( "$fname-category" );
1564 if( ( $nt->getPrefixedText() === $selflink ) &&
1565 ( $nt->getFragment() === '' ) ) {
1566 # Self-links are handled specially; generally de-link and change to bold.
1567 $s .= $prefix . $sk->makeSelfLinkObj( $nt, $text, '', $trail );
1571 # Special and Media are pseudo-namespaces; no pages actually exist in them
1572 if( $ns == NS_MEDIA
) {
1573 $link = $sk->makeMediaLinkObj( $nt, $text );
1574 # Cloak with NOPARSE to avoid replacement in replaceExternalLinks
1575 $s .= $prefix . $this->armorLinks( $link ) . $trail;
1576 $this->mOutput
->addImage( $nt->getDBkey() );
1578 } elseif( $ns == NS_SPECIAL
) {
1579 $s .= $this->makeKnownLinkHolder( $nt, $text, '', $trail, $prefix );
1581 } elseif( $ns == NS_IMAGE
) {
1582 $img = Image
::newFromTitle( $nt );
1583 if( $img->exists() ) {
1584 // Force a blue link if the file exists; may be a remote
1585 // upload on the shared repository, and we want to see its
1586 // auto-generated page.
1587 $s .= $this->makeKnownLinkHolder( $nt, $text, '', $trail, $prefix );
1591 $s .= $this->makeLinkHolder( $nt, $text, '', $trail, $prefix );
1593 wfProfileOut( $fname );
1598 * Make a link placeholder. The text returned can be later resolved to a real link with
1599 * replaceLinkHolders(). This is done for two reasons: firstly to avoid further
1600 * parsing of interwiki links, and secondly to allow all extistence checks and
1601 * article length checks (for stub links) to be bundled into a single query.
1604 function makeLinkHolder( &$nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
1605 if ( ! is_object($nt) ) {
1607 $retVal = "<!-- ERROR -->{$prefix}{$text}{$trail}";
1609 # Separate the link trail from the rest of the link
1610 list( $inside, $trail ) = Linker
::splitTrail( $trail );
1612 if ( $nt->isExternal() ) {
1613 $nr = array_push( $this->mInterwikiLinkHolders
['texts'], $prefix.$text.$inside );
1614 $this->mInterwikiLinkHolders
['titles'][] = $nt;
1615 $retVal = '<!--IWLINK '. ($nr-1) ."-->{$trail}";
1617 $nr = array_push( $this->mLinkHolders
['namespaces'], $nt->getNamespace() );
1618 $this->mLinkHolders
['dbkeys'][] = $nt->getDBkey();
1619 $this->mLinkHolders
['queries'][] = $query;
1620 $this->mLinkHolders
['texts'][] = $prefix.$text.$inside;
1621 $this->mLinkHolders
['titles'][] = $nt;
1623 $retVal = '<!--LINK '. ($nr-1) ."-->{$trail}";
1630 * Render a forced-blue link inline; protect against double expansion of
1631 * URLs if we're in a mode that prepends full URL prefixes to internal links.
1632 * Since this little disaster has to split off the trail text to avoid
1633 * breaking URLs in the following text without breaking trails on the
1634 * wiki links, it's been made into a horrible function.
1637 * @param string $text
1638 * @param string $query
1639 * @param string $trail
1640 * @param string $prefix
1641 * @return string HTML-wikitext mix oh yuck
1643 function makeKnownLinkHolder( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
1644 list( $inside, $trail ) = Linker
::splitTrail( $trail );
1645 $sk =& $this->mOptions
->getSkin();
1646 $link = $sk->makeKnownLinkObj( $nt, $text, $query, $inside, $prefix );
1647 return $this->armorLinks( $link ) . $trail;
1651 * Insert a NOPARSE hacky thing into any inline links in a chunk that's
1652 * going to go through further parsing steps before inline URL expansion.
1654 * In particular this is important when using action=render, which causes
1655 * full URLs to be included.
1657 * Oh man I hate our multi-layer parser!
1659 * @param string more-or-less HTML
1660 * @return string less-or-more HTML with NOPARSE bits
1662 function armorLinks( $text ) {
1663 return preg_replace( "/\b(" . wfUrlProtocols() . ')/',
1664 "{$this->mUniqPrefix}NOPARSE$1", $text );
1668 * Return true if subpage links should be expanded on this page.
1671 function areSubpagesAllowed() {
1672 # Some namespaces don't allow subpages
1673 global $wgNamespacesWithSubpages;
1674 return !empty($wgNamespacesWithSubpages[$this->mTitle
->getNamespace()]);
1678 * Handle link to subpage if necessary
1679 * @param string $target the source of the link
1680 * @param string &$text the link text, modified as necessary
1681 * @return string the full name of the link
1684 function maybeDoSubpageLink($target, &$text) {
1687 # :Foobar -- override special treatment of prefix (images, language links)
1688 # /Foobar -- convert to CurrentPage/Foobar
1689 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial / from text
1690 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1691 # ../Foobar -- convert to CurrentPage/Foobar, from CurrentPage/CurrentSubPage
1693 $fname = 'Parser::maybeDoSubpageLink';
1694 wfProfileIn( $fname );
1695 $ret = $target; # default return value is no change
1697 # Some namespaces don't allow subpages,
1698 # so only perform processing if subpages are allowed
1699 if( $this->areSubpagesAllowed() ) {
1700 # Look at the first character
1701 if( $target != '' && $target{0} == '/' ) {
1702 # / at end means we don't want the slash to be shown
1703 if( substr( $target, -1, 1 ) == '/' ) {
1704 $target = substr( $target, 1, -1 );
1707 $noslash = substr( $target, 1 );
1710 $ret = $this->mTitle
->getPrefixedText(). '/' . trim($noslash);
1711 if( '' === $text ) {
1713 } # this might be changed for ugliness reasons
1715 # check for .. subpage backlinks
1717 $nodotdot = $target;
1718 while( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1720 $nodotdot = substr( $nodotdot, 3 );
1722 if($dotdotcount > 0) {
1723 $exploded = explode( '/', $this->mTitle
->GetPrefixedText() );
1724 if( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1725 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1726 # / at the end means don't show full path
1727 if( substr( $nodotdot, -1, 1 ) == '/' ) {
1728 $nodotdot = substr( $nodotdot, 0, -1 );
1729 if( '' === $text ) {
1733 $nodotdot = trim( $nodotdot );
1734 if( $nodotdot != '' ) {
1735 $ret .= '/' . $nodotdot;
1742 wfProfileOut( $fname );
1747 * Used by doBlockLevels()
1750 /* private */ function closeParagraph() {
1752 if ( '' != $this->mLastSection
) {
1753 $result = '</' . $this->mLastSection
. ">\n";
1755 $this->mInPre
= false;
1756 $this->mLastSection
= '';
1759 # getCommon() returns the length of the longest common substring
1760 # of both arguments, starting at the beginning of both.
1762 /* private */ function getCommon( $st1, $st2 ) {
1763 $fl = strlen( $st1 );
1764 $shorter = strlen( $st2 );
1765 if ( $fl < $shorter ) { $shorter = $fl; }
1767 for ( $i = 0; $i < $shorter; ++
$i ) {
1768 if ( $st1{$i} != $st2{$i} ) { break; }
1772 # These next three functions open, continue, and close the list
1773 # element appropriate to the prefix character passed into them.
1775 /* private */ function openList( $char ) {
1776 $result = $this->closeParagraph();
1778 if ( '*' == $char ) { $result .= '<ul><li>'; }
1779 else if ( '#' == $char ) { $result .= '<ol><li>'; }
1780 else if ( ':' == $char ) { $result .= '<dl><dd>'; }
1781 else if ( ';' == $char ) {
1782 $result .= '<dl><dt>';
1783 $this->mDTopen
= true;
1785 else { $result = '<!-- ERR 1 -->'; }
1790 /* private */ function nextItem( $char ) {
1791 if ( '*' == $char ||
'#' == $char ) { return '</li><li>'; }
1792 else if ( ':' == $char ||
';' == $char ) {
1794 if ( $this->mDTopen
) { $close = '</dt>'; }
1795 if ( ';' == $char ) {
1796 $this->mDTopen
= true;
1797 return $close . '<dt>';
1799 $this->mDTopen
= false;
1800 return $close . '<dd>';
1803 return '<!-- ERR 2 -->';
1806 /* private */ function closeList( $char ) {
1807 if ( '*' == $char ) { $text = '</li></ul>'; }
1808 else if ( '#' == $char ) { $text = '</li></ol>'; }
1809 else if ( ':' == $char ) {
1810 if ( $this->mDTopen
) {
1811 $this->mDTopen
= false;
1812 $text = '</dt></dl>';
1814 $text = '</dd></dl>';
1817 else { return '<!-- ERR 3 -->'; }
1823 * Make lists from lines starting with ':', '*', '#', etc.
1826 * @return string the lists rendered as HTML
1828 function doBlockLevels( $text, $linestart ) {
1829 $fname = 'Parser::doBlockLevels';
1830 wfProfileIn( $fname );
1832 # Parsing through the text line by line. The main thing
1833 # happening here is handling of block-level elements p, pre,
1834 # and making lists from lines starting with * # : etc.
1836 $textLines = explode( "\n", $text );
1838 $lastPrefix = $output = '';
1839 $this->mDTopen
= $inBlockElem = false;
1841 $paragraphStack = false;
1843 if ( !$linestart ) {
1844 $output .= array_shift( $textLines );
1846 foreach ( $textLines as $oLine ) {
1847 $lastPrefixLength = strlen( $lastPrefix );
1848 $preCloseMatch = preg_match('/<\\/pre/i', $oLine );
1849 $preOpenMatch = preg_match('/<pre/i', $oLine );
1850 if ( !$this->mInPre
) {
1851 # Multiple prefixes may abut each other for nested lists.
1852 $prefixLength = strspn( $oLine, '*#:;' );
1853 $pref = substr( $oLine, 0, $prefixLength );
1856 $pref2 = str_replace( ';', ':', $pref );
1857 $t = substr( $oLine, $prefixLength );
1858 $this->mInPre
= !empty($preOpenMatch);
1860 # Don't interpret any other prefixes in preformatted text
1862 $pref = $pref2 = '';
1867 if( $prefixLength && 0 == strcmp( $lastPrefix, $pref2 ) ) {
1868 # Same as the last item, so no need to deal with nesting or opening stuff
1869 $output .= $this->nextItem( substr( $pref, -1 ) );
1870 $paragraphStack = false;
1872 if ( substr( $pref, -1 ) == ';') {
1873 # The one nasty exception: definition lists work like this:
1874 # ; title : definition text
1875 # So we check for : in the remainder text to split up the
1876 # title and definition, without b0rking links.
1878 if ($this->findColonNoLinks($t, $term, $t2) !== false) {
1880 $output .= $term . $this->nextItem( ':' );
1883 } elseif( $prefixLength ||
$lastPrefixLength ) {
1884 # Either open or close a level...
1885 $commonPrefixLength = $this->getCommon( $pref, $lastPrefix );
1886 $paragraphStack = false;
1888 while( $commonPrefixLength < $lastPrefixLength ) {
1889 $output .= $this->closeList( $lastPrefix{$lastPrefixLength-1} );
1890 --$lastPrefixLength;
1892 if ( $prefixLength <= $commonPrefixLength && $commonPrefixLength > 0 ) {
1893 $output .= $this->nextItem( $pref{$commonPrefixLength-1} );
1895 while ( $prefixLength > $commonPrefixLength ) {
1896 $char = substr( $pref, $commonPrefixLength, 1 );
1897 $output .= $this->openList( $char );
1899 if ( ';' == $char ) {
1900 # FIXME: This is dupe of code above
1901 if ($this->findColonNoLinks($t, $term, $t2) !== false) {
1903 $output .= $term . $this->nextItem( ':' );
1906 ++
$commonPrefixLength;
1908 $lastPrefix = $pref2;
1910 if( 0 == $prefixLength ) {
1911 wfProfileIn( "$fname-paragraph" );
1912 # No prefix (not in list)--go to paragraph mode
1913 // XXX: use a stack for nestable elements like span, table and div
1914 $openmatch = preg_match('/(<table|<blockquote|<h1|<h2|<h3|<h4|<h5|<h6|<pre|<tr|<p|<ul|<li|<\\/tr|<\\/td|<\\/th)/iS', $t );
1915 $closematch = preg_match(
1916 '/(<\\/table|<\\/blockquote|<\\/h1|<\\/h2|<\\/h3|<\\/h4|<\\/h5|<\\/h6|'.
1917 '<td|<th|<div|<\\/div|<hr|<\\/pre|<\\/p|'.$this->mUniqPrefix
.'-pre|<\\/li|<\\/ul)/iS', $t );
1918 if ( $openmatch or $closematch ) {
1919 $paragraphStack = false;
1920 $output .= $this->closeParagraph();
1921 if ( $preOpenMatch and !$preCloseMatch ) {
1922 $this->mInPre
= true;
1924 if ( $closematch ) {
1925 $inBlockElem = false;
1927 $inBlockElem = true;
1929 } else if ( !$inBlockElem && !$this->mInPre
) {
1930 if ( ' ' == $t{0} and ( $this->mLastSection
== 'pre' or trim($t) != '' ) ) {
1932 if ($this->mLastSection
!= 'pre') {
1933 $paragraphStack = false;
1934 $output .= $this->closeParagraph().'<pre>';
1935 $this->mLastSection
= 'pre';
1937 $t = substr( $t, 1 );
1940 if ( '' == trim($t) ) {
1941 if ( $paragraphStack ) {
1942 $output .= $paragraphStack.'<br />';
1943 $paragraphStack = false;
1944 $this->mLastSection
= 'p';
1946 if ($this->mLastSection
!= 'p' ) {
1947 $output .= $this->closeParagraph();
1948 $this->mLastSection
= '';
1949 $paragraphStack = '<p>';
1951 $paragraphStack = '</p><p>';
1955 if ( $paragraphStack ) {
1956 $output .= $paragraphStack;
1957 $paragraphStack = false;
1958 $this->mLastSection
= 'p';
1959 } else if ($this->mLastSection
!= 'p') {
1960 $output .= $this->closeParagraph().'<p>';
1961 $this->mLastSection
= 'p';
1966 wfProfileOut( "$fname-paragraph" );
1968 // somewhere above we forget to get out of pre block (bug 785)
1969 if($preCloseMatch && $this->mInPre
) {
1970 $this->mInPre
= false;
1972 if ($paragraphStack === false) {
1976 while ( $prefixLength ) {
1977 $output .= $this->closeList( $pref2{$prefixLength-1} );
1980 if ( '' != $this->mLastSection
) {
1981 $output .= '</' . $this->mLastSection
. '>';
1982 $this->mLastSection
= '';
1985 wfProfileOut( $fname );
1990 * Split up a string on ':', ignoring any occurences inside
1991 * <a>..</a> or <span>...</span>
1992 * @param string $str the string to split
1993 * @param string &$before set to everything before the ':'
1994 * @param string &$after set to everything after the ':'
1995 * return string the position of the ':', or false if none found
1997 function findColonNoLinks($str, &$before, &$after) {
1998 # I wonder if we should make this count all tags, not just <a>
1999 # and <span>. That would prevent us from matching a ':' that
2000 # comes in the middle of italics other such formatting....
2002 $fname = 'Parser::findColonNoLinks';
2003 wfProfileIn( $fname );
2006 $colon = strpos($str, ':', $pos);
2008 if ($colon !== false) {
2009 $before = substr($str, 0, $colon);
2010 $after = substr($str, $colon +
1);
2012 # Skip any ':' within <a> or <span> pairs
2013 $a = substr_count($before, '<a');
2014 $s = substr_count($before, '<span');
2015 $ca = substr_count($before, '</a>');
2016 $cs = substr_count($before, '</span>');
2018 if ($a <= $ca and $s <= $cs) {
2019 # Tags are balanced before ':'; ok
2024 } while ($colon !== false);
2025 wfProfileOut( $fname );
2030 * Return value of a magic variable (like PAGENAME)
2034 function getVariableValue( $index ) {
2035 global $wgContLang, $wgSitename, $wgServer, $wgServerName, $wgScriptPath;
2038 * Some of these require message or data lookups and can be
2039 * expensive to check many times.
2041 static $varCache = array();
2042 if ( wfRunHooks( 'ParserGetVariableValueVarCache', array( &$this, &$varCache ) ) )
2043 if ( isset( $varCache[$index] ) )
2044 return $varCache[$index];
2047 wfRunHooks( 'ParserGetVariableValueTs', array( &$this, &$ts ) );
2050 case MAG_CURRENTMONTH
:
2051 return $varCache[$index] = $wgContLang->formatNum( date( 'm', $ts ) );
2052 case MAG_CURRENTMONTHNAME
:
2053 return $varCache[$index] = $wgContLang->getMonthName( date( 'n', $ts ) );
2054 case MAG_CURRENTMONTHNAMEGEN
:
2055 return $varCache[$index] = $wgContLang->getMonthNameGen( date( 'n', $ts ) );
2056 case MAG_CURRENTMONTHABBREV
:
2057 return $varCache[$index] = $wgContLang->getMonthAbbreviation( date( 'n', $ts ) );
2058 case MAG_CURRENTDAY
:
2059 return $varCache[$index] = $wgContLang->formatNum( date( 'j', $ts ) );
2060 case MAG_CURRENTDAY2
:
2061 return $varCache[$index] = $wgContLang->formatNum( date( 'd', $ts ) );
2063 return $this->mTitle
->getText();
2065 return $this->mTitle
->getPartialURL();
2066 case MAG_FULLPAGENAME
:
2067 return $this->mTitle
->getPrefixedText();
2068 case MAG_FULLPAGENAMEE
:
2069 return $this->mTitle
->getPrefixedURL();
2070 case MAG_SUBPAGENAME
:
2071 return $this->mTitle
->getSubpageText();
2072 case MAG_REVISIONID
:
2073 return $this->mRevisionId
;
2075 return $wgContLang->getNsText( $this->mTitle
->getNamespace() );
2076 case MAG_NAMESPACEE
:
2077 return wfUrlencode( $wgContLang->getNsText( $this->mTitle
->getNamespace() ) );
2078 case MAG_CURRENTDAYNAME
:
2079 return $varCache[$index] = $wgContLang->getWeekdayName( date( 'w', $ts ) +
1 );
2080 case MAG_CURRENTYEAR
:
2081 return $varCache[$index] = $wgContLang->formatNum( date( 'Y', $ts ), true );
2082 case MAG_CURRENTTIME
:
2083 return $varCache[$index] = $wgContLang->time( wfTimestamp( TS_MW
, $ts ), false, false );
2084 case MAG_CURRENTWEEK
:
2085 // @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2086 // int to remove the padding
2087 return $varCache[$index] = $wgContLang->formatNum( (int)date( 'W', $ts ) );
2088 case MAG_CURRENTDOW
:
2089 return $varCache[$index] = $wgContLang->formatNum( date( 'w', $ts ) );
2090 case MAG_NUMBEROFARTICLES
:
2091 return $varCache[$index] = $wgContLang->formatNum( wfNumberOfArticles() );
2092 case MAG_NUMBEROFFILES
:
2093 return $varCache[$index] = $wgContLang->formatNum( wfNumberOfFiles() );
2098 case MAG_SERVERNAME
:
2099 return $wgServerName;
2100 case MAG_SCRIPTPATH
:
2101 return $wgScriptPath;
2104 if ( wfRunHooks( 'ParserGetVariableValueSwitch', array( &$this, &$varCache, &$index, &$ret ) ) )
2112 * initialise the magic variables (like CURRENTMONTHNAME)
2116 function initialiseVariables() {
2117 $fname = 'Parser::initialiseVariables';
2118 wfProfileIn( $fname );
2119 global $wgVariableIDs;
2120 $this->mVariables
= array();
2121 foreach ( $wgVariableIDs as $id ) {
2122 $mw =& MagicWord
::get( $id );
2123 $mw->addToArray( $this->mVariables
, $id );
2125 wfProfileOut( $fname );
2129 * parse any parentheses in format ((title|part|part))
2130 * and call callbacks to get a replacement text for any found piece
2132 * @param string $text The text to parse
2133 * @param array $callbacks rules in form:
2134 * '{' => array( # opening parentheses
2135 * 'end' => '}', # closing parentheses
2136 * 'cb' => array(2 => callback, # replacement callback to call if {{..}} is found
2137 * 4 => callback # replacement callback to call if {{{{..}}}} is found
2142 function replace_callback ($text, $callbacks) {
2143 $openingBraceStack = array(); # this array will hold a stack of parentheses which are not closed yet
2144 $lastOpeningBrace = -1; # last not closed parentheses
2146 for ($i = 0; $i < strlen($text); $i++
) {
2147 # check for any opening brace
2150 foreach ($callbacks as $key => $value) {
2151 $pos = strpos ($text, $key, $i);
2152 if (false !== $pos && (-1 == $nextPos ||
$pos < $nextPos)) {
2158 if ($lastOpeningBrace >= 0) {
2159 $pos = strpos ($text, $openingBraceStack[$lastOpeningBrace]['braceEnd'], $i);
2161 if (false !== $pos && (-1 == $nextPos ||
$pos < $nextPos)){
2166 $pos = strpos ($text, '|', $i);
2168 if (false !== $pos && (-1 == $nextPos ||
$pos < $nextPos)){
2179 # found openning brace, lets add it to parentheses stack
2180 if (null != $rule) {
2181 $piece = array('brace' => $text[$i],
2182 'braceEnd' => $rule['end'],
2187 # count openning brace characters
2188 while ($i+
1 < strlen($text) && $text[$i+
1] == $piece['brace']) {
2193 $piece['startAt'] = $i+
1;
2194 $piece['partStart'] = $i+
1;
2196 # we need to add to stack only if openning brace count is enough for any given rule
2197 foreach ($rule['cb'] as $cnt => $fn) {
2198 if ($piece['count'] >= $cnt) {
2199 $lastOpeningBrace ++
;
2200 $openingBraceStack[$lastOpeningBrace] = $piece;
2207 else if ($lastOpeningBrace >= 0) {
2208 # first check if it is a closing brace
2209 if ($openingBraceStack[$lastOpeningBrace]['braceEnd'] == $text[$i]) {
2210 # lets check if it is enough characters for closing brace
2212 while ($i+
$count < strlen($text) && $text[$i+
$count] == $text[$i])
2215 # if there are more closing parentheses than opening ones, we parse less
2216 if ($openingBraceStack[$lastOpeningBrace]['count'] < $count)
2217 $count = $openingBraceStack[$lastOpeningBrace]['count'];
2219 # check for maximum matching characters (if there are 5 closing characters, we will probably need only 3 - depending on the rules)
2221 $matchingCallback = null;
2222 foreach ($callbacks[$openingBraceStack[$lastOpeningBrace]['brace']]['cb'] as $cnt => $fn) {
2223 if ($count >= $cnt && $matchingCount < $cnt) {
2224 $matchingCount = $cnt;
2225 $matchingCallback = $fn;
2229 if ($matchingCount == 0) {
2234 # lets set a title or last part (if '|' was found)
2235 if (null === $openingBraceStack[$lastOpeningBrace]['parts'])
2236 $openingBraceStack[$lastOpeningBrace]['title'] = substr($text, $openingBraceStack[$lastOpeningBrace]['partStart'], $i - $openingBraceStack[$lastOpeningBrace]['partStart']);
2238 $openingBraceStack[$lastOpeningBrace]['parts'][] = substr($text, $openingBraceStack[$lastOpeningBrace]['partStart'], $i - $openingBraceStack[$lastOpeningBrace]['partStart']);
2240 $pieceStart = $openingBraceStack[$lastOpeningBrace]['startAt'] - $matchingCount;
2241 $pieceEnd = $i +
$matchingCount;
2243 if( is_callable( $matchingCallback ) ) {
2245 'text' => substr($text, $pieceStart, $pieceEnd - $pieceStart),
2246 'title' => trim($openingBraceStack[$lastOpeningBrace]['title']),
2247 'parts' => $openingBraceStack[$lastOpeningBrace]['parts'],
2248 'lineStart' => (($pieceStart > 0) && ($text[$pieceStart-1] == '\n')),
2250 # finally we can call a user callback and replace piece of text
2251 $replaceWith = call_user_func( $matchingCallback, $cbArgs );
2252 $text = substr($text, 0, $pieceStart) . $replaceWith . substr($text, $pieceEnd);
2253 $i = $pieceStart +
strlen($replaceWith) - 1;
2256 # null value for callback means that parentheses should be parsed, but not replaced
2257 $i +
= $matchingCount - 1;
2260 # reset last openning parentheses, but keep it in case there are unused characters
2261 $piece = array('brace' => $openingBraceStack[$lastOpeningBrace]['brace'],
2262 'braceEnd' => $openingBraceStack[$lastOpeningBrace]['braceEnd'],
2263 'count' => $openingBraceStack[$lastOpeningBrace]['count'],
2266 'startAt' => $openingBraceStack[$lastOpeningBrace]['startAt']);
2267 $openingBraceStack[$lastOpeningBrace--] = null;
2269 if ($matchingCount < $piece['count']) {
2270 $piece['count'] -= $matchingCount;
2271 $piece['startAt'] -= $matchingCount;
2272 $piece['partStart'] = $piece['startAt'];
2273 # do we still qualify for any callback with remaining count?
2274 foreach ($callbacks[$piece['brace']]['cb'] as $cnt => $fn) {
2275 if ($piece['count'] >= $cnt) {
2276 $lastOpeningBrace ++
;
2277 $openingBraceStack[$lastOpeningBrace] = $piece;
2285 # lets set a title if it is a first separator, or next part otherwise
2286 if ($text[$i] == '|') {
2287 if (null === $openingBraceStack[$lastOpeningBrace]['parts']) {
2288 $openingBraceStack[$lastOpeningBrace]['title'] = substr($text, $openingBraceStack[$lastOpeningBrace]['partStart'], $i - $openingBraceStack[$lastOpeningBrace]['partStart']);
2289 $openingBraceStack[$lastOpeningBrace]['parts'] = array();
2292 $openingBraceStack[$lastOpeningBrace]['parts'][] = substr($text, $openingBraceStack[$lastOpeningBrace]['partStart'], $i - $openingBraceStack[$lastOpeningBrace]['partStart']);
2294 $openingBraceStack[$lastOpeningBrace]['partStart'] = $i +
1;
2303 * Replace magic variables, templates, and template arguments
2304 * with the appropriate text. Templates are substituted recursively,
2305 * taking care to avoid infinite loops.
2307 * Note that the substitution depends on value of $mOutputType:
2308 * OT_WIKI: only {{subst:}} templates
2309 * OT_MSG: only magic variables
2310 * OT_HTML: all templates and magic variables
2312 * @param string $tex The text to transform
2313 * @param array $args Key-value pairs representing template parameters to substitute
2314 * @param bool $argsOnly Only do argument (triple-brace) expansion, not double-brace expansion
2317 function replaceVariables( $text, $args = array(), $argsOnly = false ) {
2318 # Prevent too big inclusions
2319 if( strlen( $text ) > MAX_INCLUDE_SIZE
) {
2323 $fname = 'Parser::replaceVariables';
2324 wfProfileIn( $fname );
2326 # This function is called recursively. To keep track of arguments we need a stack:
2327 array_push( $this->mArgStack
, $args );
2329 $braceCallbacks = array();
2331 $braceCallbacks[2] = array( &$this, 'braceSubstitution' );
2333 if ( $this->mOutputType
== OT_HTML ||
$this->mOutputType
== OT_WIKI
) {
2334 $braceCallbacks[3] = array( &$this, 'argSubstitution' );
2336 $callbacks = array();
2337 $callbacks['{'] = array('end' => '}', 'cb' => $braceCallbacks);
2338 $callbacks['['] = array('end' => ']', 'cb' => array(2=>null));
2339 $text = $this->replace_callback ($text, $callbacks);
2341 array_pop( $this->mArgStack
);
2343 wfProfileOut( $fname );
2348 * Replace magic variables
2351 function variableSubstitution( $matches ) {
2352 $fname = 'Parser::variableSubstitution';
2353 $varname = $matches[1];
2354 wfProfileIn( $fname );
2355 if ( !$this->mVariables
) {
2356 $this->initialiseVariables();
2359 if ( $this->mOutputType
== OT_WIKI
) {
2360 # Do only magic variables prefixed by SUBST
2361 $mwSubst =& MagicWord
::get( MAG_SUBST
);
2362 if (!$mwSubst->matchStartAndRemove( $varname ))
2364 # Note that if we don't substitute the variable below,
2365 # we don't remove the {{subst:}} magic word, in case
2366 # it is a template rather than a magic variable.
2368 if ( !$skip && array_key_exists( $varname, $this->mVariables
) ) {
2369 $id = $this->mVariables
[$varname];
2370 $text = $this->getVariableValue( $id );
2371 $this->mOutput
->mContainsOldMagic
= true;
2373 $text = $matches[0];
2375 wfProfileOut( $fname );
2379 # Split template arguments
2380 function getTemplateArgs( $argsString ) {
2381 if ( $argsString === '' ) {
2385 $args = explode( '|', substr( $argsString, 1 ) );
2387 # If any of the arguments contains a '[[' but no ']]', it needs to be
2388 # merged with the next arg because the '|' character between belongs
2389 # to the link syntax and not the template parameter syntax.
2390 $argc = count($args);
2392 for ( $i = 0; $i < $argc-1; $i++
) {
2393 if ( substr_count ( $args[$i], '[[' ) != substr_count ( $args[$i], ']]' ) ) {
2394 $args[$i] .= '|'.$args[$i+
1];
2395 array_splice($args, $i+
1, 1);
2405 * Return the text of a template, after recursively
2406 * replacing any variables or templates within the template.
2408 * @param array $piece The parts of the template
2409 * $piece['text']: matched text
2410 * $piece['title']: the title, i.e. the part before the |
2411 * $piece['parts']: the parameter array
2412 * @return string the text of the template
2415 function braceSubstitution( $piece ) {
2417 $fname = 'Parser::braceSubstitution';
2418 wfProfileIn( $fname );
2421 $found = false; # $text has been filled
2422 $nowiki = false; # wiki markup in $text should be escaped
2423 $noparse = false; # Unsafe HTML tags should not be stripped, etc.
2424 $noargs = false; # Don't replace triple-brace arguments in $text
2425 $replaceHeadings = false; # Make the edit section links go to the template not the article
2426 $isHTML = false; # $text is HTML, armour it against wikitext transformation
2427 $forceRawInterwiki = false; # Force interwiki transclusion to be done in raw mode not rendered
2429 # Title object, where $text came from
2434 # $part1 is the bit before the first |, and must contain only title characters
2435 # $args is a list of arguments, starting from index 0, not including $part1
2437 $part1 = $piece['title'];
2438 # If the third subpattern matched anything, it will start with |
2440 if (null == $piece['parts']) {
2441 $replaceWith = $this->variableSubstitution (array ($piece['text'], $piece['title']));
2442 if ($replaceWith != $piece['text']) {
2443 $text = $replaceWith;
2450 $args = (null == $piece['parts']) ?
array() : $piece['parts'];
2451 $argc = count( $args );
2455 $mwSubst =& MagicWord
::get( MAG_SUBST
);
2456 if ( $mwSubst->matchStartAndRemove( $part1 ) xor ($this->mOutputType
== OT_WIKI
) ) {
2457 # One of two possibilities is true:
2458 # 1) Found SUBST but not in the PST phase
2459 # 2) Didn't find SUBST and in the PST phase
2460 # In either case, return without further processing
2461 $text = $piece['text'];
2468 # MSG, MSGNW, INT and RAW
2471 $mwMsgnw =& MagicWord
::get( MAG_MSGNW
);
2472 if ( $mwMsgnw->matchStartAndRemove( $part1 ) ) {
2475 # Remove obsolete MSG:
2476 $mwMsg =& MagicWord
::get( MAG_MSG
);
2477 $mwMsg->matchStartAndRemove( $part1 );
2481 $mwRaw =& MagicWord
::get( MAG_RAW
);
2482 if ( $mwRaw->matchStartAndRemove( $part1 ) ) {
2483 $forceRawInterwiki = true;
2486 # Check if it is an internal message
2487 $mwInt =& MagicWord
::get( MAG_INT
);
2488 if ( $mwInt->matchStartAndRemove( $part1 ) ) {
2489 if ( $this->incrementIncludeCount( 'int:'.$part1 ) ) {
2490 $text = $linestart . wfMsgReal( $part1, $args, true );
2498 # Check for NS: (namespace expansion)
2499 $mwNs = MagicWord
::get( MAG_NS
);
2500 if ( $mwNs->matchStartAndRemove( $part1 ) ) {
2501 if ( intval( $part1 ) ||
$part1 == "0" ) {
2502 $text = $linestart . $wgContLang->getNsText( intval( $part1 ) );
2505 $index = Namespace::getCanonicalIndex( strtolower( $part1 ) );
2506 if ( !is_null( $index ) ) {
2507 $text = $linestart . $wgContLang->getNsText( $index );
2514 # LCFIRST, UCFIRST, LC and UC
2516 $lcfirst =& MagicWord
::get( MAG_LCFIRST
);
2517 $ucfirst =& MagicWord
::get( MAG_UCFIRST
);
2518 $lc =& MagicWord
::get( MAG_LC
);
2519 $uc =& MagicWord
::get( MAG_UC
);
2520 if ( $lcfirst->matchStartAndRemove( $part1 ) ) {
2521 $text = $linestart . $wgContLang->lcfirst( $part1 );
2523 } else if ( $ucfirst->matchStartAndRemove( $part1 ) ) {
2524 $text = $linestart . $wgContLang->ucfirst( $part1 );
2526 } else if ( $lc->matchStartAndRemove( $part1 ) ) {
2527 $text = $linestart . $wgContLang->lc( $part1 );
2529 } else if ( $uc->matchStartAndRemove( $part1 ) ) {
2530 $text = $linestart . $wgContLang->uc( $part1 );
2535 # LOCALURL and FULLURL
2537 $mwLocal =& MagicWord
::get( MAG_LOCALURL
);
2538 $mwLocalE =& MagicWord
::get( MAG_LOCALURLE
);
2539 $mwFull =& MagicWord
::get( MAG_FULLURL
);
2540 $mwFullE =& MagicWord
::get( MAG_FULLURLE
);
2543 if ( $mwLocal->matchStartAndRemove( $part1 ) ) {
2544 $func = 'getLocalURL';
2545 } elseif ( $mwLocalE->matchStartAndRemove( $part1 ) ) {
2546 $func = 'escapeLocalURL';
2547 } elseif ( $mwFull->matchStartAndRemove( $part1 ) ) {
2548 $func = 'getFullURL';
2549 } elseif ( $mwFullE->matchStartAndRemove( $part1 ) ) {
2550 $func = 'escapeFullURL';
2555 if ( $func !== false ) {
2556 $title = Title
::newFromText( $part1 );
2557 if ( !is_null( $title ) ) {
2559 $text = $linestart . $title->$func( $args[0] );
2561 $text = $linestart . $title->$func();
2569 if ( !$found && $argc == 1 ) {
2570 $mwGrammar =& MagicWord
::get( MAG_GRAMMAR
);
2571 if ( $mwGrammar->matchStartAndRemove( $part1 ) ) {
2572 $text = $linestart . $wgContLang->convertGrammar( $args[0], $part1 );
2578 if ( !$found && $argc >= 2 ) {
2579 $mwPluralForm =& MagicWord
::get( MAG_PLURAL
);
2580 if ( $mwPluralForm->matchStartAndRemove( $part1 ) ) {
2581 if ($argc==2) {$args[2]=$args[1];}
2582 $text = $linestart . $wgContLang->convertPlural( $part1, $args[0], $args[1], $args[2]);
2587 # Template table test
2589 # Did we encounter this template already? If yes, it is in the cache
2590 # and we need to check for loops.
2591 if ( !$found && isset( $this->mTemplates
[$piece['title']] ) ) {
2594 # Infinite loop test
2595 if ( isset( $this->mTemplatePath
[$part1] ) ) {
2599 $text = $linestart .
2600 '{{' . $part1 . '}}' .
2601 '<!-- WARNING: template loop detected -->';
2602 wfDebug( "$fname: template loop broken at '$part1'\n" );
2604 # set $text to cached message.
2605 $text = $linestart . $this->mTemplates
[$piece['title']];
2609 # Load from database
2610 $lastPathLevel = $this->mTemplatePath
;
2613 $part1 = $this->maybeDoSubpageLink( $part1, $subpage='' );
2614 if ($subpage !== '') {
2615 $ns = $this->mTitle
->getNamespace();
2617 $title = Title
::newFromText( $part1, $ns );
2619 if ( !is_null( $title ) ) {
2620 if ( !$title->isExternal() ) {
2621 # Check for excessive inclusion
2622 $dbk = $title->getPrefixedDBkey();
2623 if ( $this->incrementIncludeCount( $dbk ) ) {
2624 if ( $title->getNamespace() == NS_SPECIAL
&& $this->mOptions
->getAllowSpecialInclusion() ) {
2625 # Capture special page output
2626 $text = SpecialPage
::capturePath( $title );
2627 if ( is_string( $text ) ) {
2632 $this->disableCache();
2635 $articleContent = $this->fetchTemplate( $title );
2636 if ( $articleContent !== false ) {
2638 $text = $articleContent;
2639 $replaceHeadings = true;
2644 # If the title is valid but undisplayable, make a link to it
2645 if ( $this->mOutputType
== OT_HTML
&& !$found ) {
2646 $text = '[['.$title->getPrefixedText().']]';
2649 } elseif ( $title->isTrans() ) {
2650 // Interwiki transclusion
2651 if ( $this->mOutputType
== OT_HTML
&& !$forceRawInterwiki ) {
2652 $text = $this->interwikiTransclude( $title, 'render' );
2656 $text = $this->interwikiTransclude( $title, 'raw' );
2657 $replaceHeadings = true;
2662 # Template cache array insertion
2663 # Use the original $piece['title'] not the mangled $part1, so that
2664 # modifiers such as RAW: produce separate cache entries
2666 $this->mTemplates
[$piece['title']] = $text;
2667 $text = $linestart . $text;
2672 # Recursive parsing, escaping and link table handling
2673 # Only for HTML output
2674 if ( $nowiki && $found && $this->mOutputType
== OT_HTML
) {
2675 $text = wfEscapeWikiText( $text );
2676 } elseif ( ($this->mOutputType
== OT_HTML ||
$this->mOutputType
== OT_WIKI
) && $found ) {
2678 # Clean up argument array
2679 $assocArgs = array();
2681 foreach( $args as $arg ) {
2682 $eqpos = strpos( $arg, '=' );
2683 if ( $eqpos === false ) {
2684 $assocArgs[$index++
] = $arg;
2686 $name = trim( substr( $arg, 0, $eqpos ) );
2687 $value = trim( substr( $arg, $eqpos+
1 ) );
2688 if ( $value === false ) {
2691 if ( $name !== false ) {
2692 $assocArgs[$name] = $value;
2697 # Add a new element to the templace recursion path
2698 $this->mTemplatePath
[$part1] = 1;
2702 # If there are any <onlyinclude> tags, only include them
2703 if ( in_string( '<onlyinclude>', $text ) && in_string( '</onlyinclude>', $text ) ) {
2704 preg_match_all( '/<onlyinclude>(.*?)\n?<\/onlyinclude>/s', $text, $m );
2706 foreach ($m[1] as $piece)
2709 # Remove <noinclude> sections and <includeonly> tags
2710 $text = preg_replace( '/<noinclude>.*?<\/noinclude>/s', '', $text );
2711 $text = strtr( $text, array( '<includeonly>' => '' , '</includeonly>' => '' ) );
2713 if( $this->mOutputType
== OT_HTML
) {
2714 # Strip <nowiki>, <pre>, etc.
2715 $text = $this->strip( $text, $this->mStripState
);
2716 $text = Sanitizer
::removeHTMLtags( $text, array( &$this, 'replaceVariables' ), $assocArgs );
2718 $text = $this->replaceVariables( $text, $assocArgs );
2720 # If the template begins with a table or block-level
2721 # element, it should be treated as beginning a new line.
2722 if (!$piece['lineStart'] && preg_match('/^({\\||:|;|#|\*)/', $text)) {
2723 $text = "\n" . $text;
2725 } elseif ( !$noargs ) {
2726 # $noparse and !$noargs
2727 # Just replace the arguments, not any double-brace items
2728 # This is used for rendered interwiki transclusion
2729 $text = $this->replaceVariables( $text, $assocArgs, true );
2732 # Prune lower levels off the recursion check path
2733 $this->mTemplatePath
= $lastPathLevel;
2736 wfProfileOut( $fname );
2737 return $piece['text'];
2740 # Replace raw HTML by a placeholder
2741 # Add a blank line preceding, to prevent it from mucking up
2742 # immediately preceding headings
2743 $text = "\n\n" . $this->insertStripItem( $text, $this->mStripState
);
2745 # replace ==section headers==
2746 # XXX this needs to go away once we have a better parser.
2747 if ( $this->mOutputType
!= OT_WIKI
&& $replaceHeadings ) {
2748 if( !is_null( $title ) )
2749 $encodedname = base64_encode($title->getPrefixedDBkey());
2751 $encodedname = base64_encode("");
2752 $m = preg_split('/(^={1,6}.*?={1,6}\s*?$)/m', $text, -1,
2753 PREG_SPLIT_DELIM_CAPTURE
);
2756 for( $i = 0; $i < count($m); $i +
= 2 ) {
2758 if (!isset($m[$i +
1]) ||
$m[$i +
1] == "") continue;
2760 if( strstr($hl, "<!--MWTEMPLATESECTION") ) {
2764 preg_match('/^(={1,6})(.*?)(={1,6})\s*?$/m', $hl, $m2);
2765 $text .= $m2[1] . $m2[2] . "<!--MWTEMPLATESECTION="
2766 . $encodedname . "&" . base64_encode("$nsec") . "-->" . $m2[3];
2774 # Prune lower levels off the recursion check path
2775 $this->mTemplatePath
= $lastPathLevel;
2778 wfProfileOut( $fname );
2779 return $piece['text'];
2781 wfProfileOut( $fname );
2787 * Fetch the unparsed text of a template and register a reference to it.
2789 function fetchTemplate( $title ) {
2791 // Loop to fetch the article, with up to 1 redirect
2792 for ( $i = 0; $i < 2 && is_object( $title ); $i++
) {
2793 $rev = Revision
::newFromTitle( $title );
2794 $this->mOutput
->addTemplate( $title, $title->getArticleID() );
2798 $text = $rev->getText();
2799 if ( $text === false ) {
2803 $title = Title
::newFromRedirect( $text );
2809 * Transclude an interwiki link.
2811 function interwikiTransclude( $title, $action ) {
2812 global $wgEnableScaryTranscluding, $wgCanonicalNamespaceNames;
2814 if (!$wgEnableScaryTranscluding)
2815 return wfMsg('scarytranscludedisabled');
2817 // The namespace will actually only be 0 or 10, depending on whether there was a leading :
2818 // But we'll handle it generally anyway
2819 if ( $title->getNamespace() ) {
2820 // Use the canonical namespace, which should work anywhere
2821 $articleName = $wgCanonicalNamespaceNames[$title->getNamespace()] . ':' . $title->getDBkey();
2823 $articleName = $title->getDBkey();
2826 $url = str_replace('$1', urlencode($articleName), Title
::getInterwikiLink($title->getInterwiki()));
2827 $url .= "?action=$action";
2828 if (strlen($url) > 255)
2829 return wfMsg('scarytranscludetoolong');
2830 return $this->fetchScaryTemplateMaybeFromCache($url);
2833 function fetchScaryTemplateMaybeFromCache($url) {
2834 global $wgTranscludeCacheExpiry;
2835 $dbr =& wfGetDB(DB_SLAVE
);
2836 $obj = $dbr->selectRow('transcache', array('tc_time', 'tc_contents'),
2837 array('tc_url' => $url));
2839 $time = $obj->tc_time
;
2840 $text = $obj->tc_contents
;
2841 if ($time && time() < $time +
$wgTranscludeCacheExpiry ) {
2846 $text = wfGetHTTP($url);
2848 return wfMsg('scarytranscludefailed', $url);
2850 $dbw =& wfGetDB(DB_MASTER
);
2851 $dbw->replace('transcache', array('tc_url'), array(
2853 'tc_time' => time(),
2854 'tc_contents' => $text));
2860 * Triple brace replacement -- used for template arguments
2863 function argSubstitution( $matches ) {
2864 $arg = trim( $matches['title'] );
2865 $text = $matches['text'];
2866 $inputArgs = end( $this->mArgStack
);
2868 if ( array_key_exists( $arg, $inputArgs ) ) {
2869 $text = $inputArgs[$arg];
2870 } else if ($this->mOutputType
== OT_HTML
&& null != $matches['parts'] && count($matches['parts']) > 0) {
2871 $text = $matches['parts'][0];
2878 * Returns true if the function is allowed to include this entity
2881 function incrementIncludeCount( $dbk ) {
2882 if ( !array_key_exists( $dbk, $this->mIncludeCount
) ) {
2883 $this->mIncludeCount
[$dbk] = 0;
2885 if ( ++
$this->mIncludeCount
[$dbk] <= MAX_INCLUDE_REPEAT
) {
2893 * This function accomplishes several tasks:
2894 * 1) Auto-number headings if that option is enabled
2895 * 2) Add an [edit] link to sections for logged in users who have enabled the option
2896 * 3) Add a Table of contents on the top for users who have enabled the option
2897 * 4) Auto-anchor headings
2899 * It loops through all headlines, collects the necessary data, then splits up the
2900 * string and re-inserts the newly formatted headlines.
2902 * @param string $text
2903 * @param boolean $isMain
2906 function formatHeadings( $text, $isMain=true ) {
2907 global $wgMaxTocLevel, $wgContLang;
2909 $doNumberHeadings = $this->mOptions
->getNumberHeadings();
2911 $forceTocHere = false;
2912 if( !$this->mTitle
->userCanEdit() ) {
2915 $showEditLink = $this->mOptions
->getEditSection();
2918 # Inhibit editsection links if requested in the page
2919 $esw =& MagicWord
::get( MAG_NOEDITSECTION
);
2920 if( $esw->matchAndRemove( $text ) ) {
2923 # if the string __NOTOC__ (not case-sensitive) occurs in the HTML,
2925 $mw =& MagicWord
::get( MAG_NOTOC
);
2926 if( $mw->matchAndRemove( $text ) ) {
2930 # Get all headlines for numbering them and adding funky stuff like [edit]
2931 # links - this is for later, but we need the number of headlines right now
2932 $numMatches = preg_match_all( '/<H([1-6])(.*?'.'>)(.*?)<\/H[1-6] *>/i', $text, $matches );
2934 # if there are fewer than 4 headlines in the article, do not show TOC
2935 if( $numMatches < 4 ) {
2939 # if the string __TOC__ (not case-sensitive) occurs in the HTML,
2940 # override above conditions and always show TOC at that place
2942 $mw =& MagicWord
::get( MAG_TOC
);
2943 if($mw->match( $text ) ) {
2945 $forceTocHere = true;
2947 # if the string __FORCETOC__ (not case-sensitive) occurs in the HTML,
2948 # override above conditions and always show TOC above first header
2949 $mw =& MagicWord
::get( MAG_FORCETOC
);
2950 if ($mw->matchAndRemove( $text ) ) {
2955 # Never ever show TOC if no headers
2956 if( $numMatches < 1 ) {
2960 # We need this to perform operations on the HTML
2961 $sk =& $this->mOptions
->getSkin();
2965 $sectionCount = 0; # headlineCount excluding template sections
2967 # Ugh .. the TOC should have neat indentation levels which can be
2968 # passed to the skin functions. These are determined here
2972 $sublevelCount = array();
2973 $levelCount = array();
2980 foreach( $matches[3] as $headline ) {
2982 $templatetitle = '';
2983 $templatesection = 0;
2986 if (preg_match("/<!--MWTEMPLATESECTION=([^&]+)&([^_]+)-->/", $headline, $mat)) {
2988 $templatetitle = base64_decode($mat[1]);
2989 $templatesection = 1 +
(int)base64_decode($mat[2]);
2990 $headline = preg_replace("/<!--MWTEMPLATESECTION=([^&]+)&([^_]+)-->/", "", $headline);
2994 $prevlevel = $level;
2995 $prevtoclevel = $toclevel;
2997 $level = $matches[1][$headlineCount];
2999 if( $doNumberHeadings ||
$doShowToc ) {
3001 if ( $level > $prevlevel ) {
3002 # Increase TOC level
3004 $sublevelCount[$toclevel] = 0;
3005 $toc .= $sk->tocIndent();
3007 elseif ( $level < $prevlevel && $toclevel > 1 ) {
3008 # Decrease TOC level, find level to jump to
3010 if ( $toclevel == 2 && $level <= $levelCount[1] ) {
3011 # Can only go down to level 1
3014 for ($i = $toclevel; $i > 0; $i--) {
3015 if ( $levelCount[$i] == $level ) {
3016 # Found last matching level
3020 elseif ( $levelCount[$i] < $level ) {
3021 # Found first matching level below current level
3028 $toc .= $sk->tocUnindent( $prevtoclevel - $toclevel );
3031 # No change in level, end TOC line
3032 $toc .= $sk->tocLineEnd();
3035 $levelCount[$toclevel] = $level;
3037 # count number of headlines for each level
3038 @$sublevelCount[$toclevel]++
;
3040 for( $i = 1; $i <= $toclevel; $i++
) {
3041 if( !empty( $sublevelCount[$i] ) ) {
3045 $numbering .= $wgContLang->formatNum( $sublevelCount[$i] );
3051 # The canonized header is a version of the header text safe to use for links
3052 # Avoid insertion of weird stuff like <math> by expanding the relevant sections
3053 $canonized_headline = $this->unstrip( $headline, $this->mStripState
);
3054 $canonized_headline = $this->unstripNoWiki( $canonized_headline, $this->mStripState
);
3056 # Remove link placeholders by the link text.
3057 # <!--LINK number-->
3059 # link text with suffix
3060 $canonized_headline = preg_replace( '/<!--LINK ([0-9]*)-->/e',
3061 "\$this->mLinkHolders['texts'][\$1]",
3062 $canonized_headline );
3063 $canonized_headline = preg_replace( '/<!--IWLINK ([0-9]*)-->/e',
3064 "\$this->mInterwikiLinkHolders['texts'][\$1]",
3065 $canonized_headline );
3068 $canonized_headline = preg_replace( '/<.*?' . '>/','',$canonized_headline );
3069 $tocline = trim( $canonized_headline );
3070 # Save headline for section edit hint before it's escaped
3071 $headline_hint = trim( $canonized_headline );
3072 $canonized_headline = Sanitizer
::escapeId( $tocline );
3073 $refers[$headlineCount] = $canonized_headline;
3075 # count how many in assoc. array so we can track dupes in anchors
3076 @$refers[$canonized_headline]++
;
3077 $refcount[$headlineCount]=$refers[$canonized_headline];
3079 # Don't number the heading if it is the only one (looks silly)
3080 if( $doNumberHeadings && count( $matches[3] ) > 1) {
3081 # the two are different if the line contains a link
3082 $headline=$numbering . ' ' . $headline;
3085 # Create the anchor for linking from the TOC to the section
3086 $anchor = $canonized_headline;
3087 if($refcount[$headlineCount] > 1 ) {
3088 $anchor .= '_' . $refcount[$headlineCount];
3090 if( $doShowToc && ( !isset($wgMaxTocLevel) ||
$toclevel<$wgMaxTocLevel ) ) {
3091 $toc .= $sk->tocLine($anchor, $tocline, $numbering, $toclevel);
3093 if( $showEditLink && ( !$istemplate ||
$templatetitle !== "" ) ) {
3094 if ( empty( $head[$headlineCount] ) ) {
3095 $head[$headlineCount] = '';
3098 $head[$headlineCount] .= $sk->editSectionLinkForOther($templatetitle, $templatesection);
3100 $head[$headlineCount] .= $sk->editSectionLink($this->mTitle
, $sectionCount+
1, $headline_hint);
3103 # give headline the correct <h#> tag
3104 @$head[$headlineCount] .= "<a name=\"$anchor\"></a><h".$level.$matches[2][$headlineCount] .$headline.'</h'.$level.'>';
3112 $toc .= $sk->tocUnindent( $toclevel - 1 );
3113 $toc = $sk->tocList( $toc );
3116 # split up and insert constructed headlines
3118 $blocks = preg_split( '/<H[1-6].*?' . '>.*?<\/H[1-6]>/i', $text );
3121 foreach( $blocks as $block ) {
3122 if( $showEditLink && $headlineCount > 0 && $i == 0 && $block != "\n" ) {
3123 # This is the [edit] link that appears for the top block of text when
3124 # section editing is enabled
3126 # Disabled because it broke block formatting
3127 # For example, a bullet point in the top line
3128 # $full .= $sk->editSectionLink(0);
3131 if( $doShowToc && !$i && $isMain && !$forceTocHere) {
3132 # Top anchor now in skin
3136 if( !empty( $head[$i] ) ) {
3142 $mw =& MagicWord
::get( MAG_TOC
);
3143 return $mw->replace( $toc, $full );
3150 * Return an HTML link for the "ISBN 123456" text
3153 function magicISBN( $text ) {
3154 $fname = 'Parser::magicISBN';
3155 wfProfileIn( $fname );
3157 $a = split( 'ISBN ', ' '.$text );
3158 if ( count ( $a ) < 2 ) {
3159 wfProfileOut( $fname );
3162 $text = substr( array_shift( $a ), 1);
3163 $valid = '0123456789-Xx';
3165 foreach ( $a as $x ) {
3166 $isbn = $blank = '' ;
3167 while ( ' ' == $x{0} ) {
3169 $x = substr( $x, 1 );
3171 if ( $x == '' ) { # blank isbn
3172 $text .= "ISBN $blank";
3175 while ( strstr( $valid, $x{0} ) != false ) {
3177 $x = substr( $x, 1 );
3179 $num = str_replace( '-', '', $isbn );
3180 $num = str_replace( ' ', '', $num );
3181 $num = str_replace( 'x', 'X', $num );
3184 $text .= "ISBN $blank$x";
3186 $titleObj = Title
::makeTitle( NS_SPECIAL
, 'Booksources' );
3187 $text .= '<a href="' .
3188 $titleObj->escapeLocalUrl( 'isbn='.$num ) .
3189 "\" class=\"internal\">ISBN $isbn</a>";
3193 wfProfileOut( $fname );
3198 * Return an HTML link for the "RFC 1234" text
3201 * @param string $text Text to be processed
3202 * @param string $keyword Magic keyword to use (default RFC)
3203 * @param string $urlmsg Interface message to use (default rfcurl)
3206 function magicRFC( $text, $keyword='RFC ', $urlmsg='rfcurl' ) {
3208 $valid = '0123456789';
3211 $a = split( $keyword, ' '.$text );
3212 if ( count ( $a ) < 2 ) {
3215 $text = substr( array_shift( $a ), 1);
3217 /* Check if keyword is preceed by [[.
3218 * This test is made here cause of the array_shift above
3219 * that prevent the test to be done in the foreach.
3221 if ( substr( $text, -2 ) == '[[' ) {
3225 foreach ( $a as $x ) {
3226 /* token might be empty if we have RFC RFC 1234 */
3234 /** remove and save whitespaces in $blank */
3235 while ( $x{0} == ' ' ) {
3237 $x = substr( $x, 1 );
3240 /** remove and save the rfc number in $id */
3241 while ( strstr( $valid, $x{0} ) != false ) {
3243 $x = substr( $x, 1 );
3247 /* call back stripped spaces*/
3248 $text .= $keyword.$blank.$x;
3249 } elseif( $internal ) {
3251 $text .= $keyword.$id.$x;
3253 /* build the external link*/
3254 $url = wfMsg( $urlmsg, $id);
3255 $sk =& $this->mOptions
->getSkin();
3256 $la = $sk->getExternalLinkAttributes( $url, $keyword.$id );
3257 $text .= "<a href='{$url}'{$la}>{$keyword}{$id}</a>{$x}";
3260 /* Check if the next RFC keyword is preceed by [[ */
3261 $internal = ( substr($x,-2) == '[[' );
3267 * Transform wiki markup when saving a page by doing \r\n -> \n
3268 * conversion, substitting signatures, {{subst:}} templates, etc.
3270 * @param string $text the text to transform
3271 * @param Title &$title the Title object for the current article
3272 * @param User &$user the User object describing the current user
3273 * @param ParserOptions $options parsing options
3274 * @param bool $clearState whether to clear the parser state first
3275 * @return string the altered wiki markup
3278 function preSaveTransform( $text, &$title, &$user, $options, $clearState = true ) {
3279 $this->mOptions
= $options;
3280 $this->mTitle
=& $title;
3281 $this->mOutputType
= OT_WIKI
;
3283 if ( $clearState ) {
3284 $this->clearState();
3287 $stripState = false;
3291 $text = str_replace( array_keys( $pairs ), array_values( $pairs ), $text );
3292 $text = $this->strip( $text, $stripState, true );
3293 $text = $this->pstPass2( $text, $user );
3294 $text = $this->unstrip( $text, $stripState );
3295 $text = $this->unstripNoWiki( $text, $stripState );
3300 * Pre-save transform helper function
3303 function pstPass2( $text, &$user ) {
3304 global $wgContLang, $wgLocaltimezone;
3306 /* Note: This is the timestamp saved as hardcoded wikitext to
3307 * the database, we use $wgContLang here in order to give
3308 * everyone the same signiture and use the default one rather
3309 * than the one selected in each users preferences.
3311 if ( isset( $wgLocaltimezone ) ) {
3312 $oldtz = getenv( 'TZ' );
3313 putenv( 'TZ='.$wgLocaltimezone );
3315 $d = $wgContLang->timeanddate( date( 'YmdHis' ), false, false) .
3316 ' (' . date( 'T' ) . ')';
3317 if ( isset( $wgLocaltimezone ) ) {
3318 putenv( 'TZ='.$oldtz );
3321 # Variable replacement
3322 # Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
3323 $text = $this->replaceVariables( $text );
3326 $sigText = $this->getUserSig( $user );
3327 $text = strtr( $text, array(
3329 '~~~~' => "$sigText $d",
3333 # Context links: [[|name]] and [[name (context)|]]
3335 global $wgLegalTitleChars;
3336 $tc = "[$wgLegalTitleChars]";
3337 $np = str_replace( array( '(', ')' ), array( '', '' ), $tc ); # No parens
3339 $namespacechar = '[ _0-9A-Za-z\x80-\xff]'; # Namespaces can use non-ascii!
3340 $conpat = "/^({$np}+) \\(({$tc}+)\\)$/";
3342 $p1 = "/\[\[({$np}+) \\(({$np}+)\\)\\|]]/"; # [[page (context)|]]
3343 $p2 = "/\[\[\\|({$tc}+)]]/"; # [[|page]]
3344 $p3 = "/\[\[(:*$namespacechar+):({$np}+)\\|]]/"; # [[namespace:page|]] and [[:namespace:page|]]
3345 $p4 = "/\[\[(:*$namespacechar+):({$np}+) \\(({$np}+)\\)\\|]]/"; # [[ns:page (cont)|]] and [[:ns:page (cont)|]]
3347 $t = $this->mTitle
->getText();
3348 if ( preg_match( $conpat, $t, $m ) ) {
3351 $text = preg_replace( $p4, '[[\\1:\\2 (\\3)|\\2]]', $text );
3352 $text = preg_replace( $p1, '[[\\1 (\\2)|\\1]]', $text );
3353 $text = preg_replace( $p3, '[[\\1:\\2|\\2]]', $text );
3355 if ( '' == $context ) {
3356 $text = preg_replace( $p2, '[[\\1]]', $text );
3358 $text = preg_replace( $p2, "[[\\1 ({$context})|\\1]]", $text );
3361 # Trim trailing whitespace
3362 # MAG_END (__END__) tag allows for trailing
3363 # whitespace to be deliberately included
3364 $text = rtrim( $text );
3365 $mw =& MagicWord
::get( MAG_END
);
3366 $mw->matchAndRemove( $text );
3372 * Fetch the user's signature text, if any, and normalize to
3373 * validated, ready-to-insert wikitext.
3379 function getUserSig( &$user ) {
3380 $username = $user->getName();
3381 $nickname = $user->getOption( 'nickname' );
3382 $nickname = $nickname === '' ?
$username : $nickname;
3384 if( $user->getBoolOption( 'fancysig' ) !== false ) {
3385 # Sig. might contain markup; validate this
3386 if( $this->validateSig( $nickname ) !== false ) {
3387 # Validated; clean up (if needed) and return it
3388 return( $this->cleanSig( $nickname ) );
3390 # Failed to validate; fall back to the default
3391 $nickname = $username;
3392 wfDebug( "Parser::getUserSig: $username has bad XML tags in signature.\n" );
3396 # If we're still here, make it a link to the user page
3397 $userpage = $user->getUserPage();
3398 return( '[[' . $userpage->getPrefixedText() . '|' . wfEscapeWikiText( $nickname ) . ']]' );
3402 * Check that the user's signature contains no bad XML
3404 * @param string $text
3405 * @return mixed An expanded string, or false if invalid.
3407 function validateSig( $text ) {
3408 return( wfIsWellFormedXmlFragment( $text ) ?
$text : false );
3412 * Clean up signature text
3414 * 1) Strip ~~~, ~~~~ and ~~~~~ out of signatures
3415 * 2) Substitute all transclusions
3417 * @param string $text
3418 * @return string Signature text
3420 function cleanSig( $text ) {
3421 $substWord = MagicWord
::get( MAG_SUBST
);
3422 $substRegex = '/\{\{(?!(?:' . $substWord->getBaseRegex() . '))/x' . $substWord->getRegexCase();
3423 $substText = '{{' . $substWord->getSynonym( 0 );
3425 $text = preg_replace( $substRegex, $substText, $text );
3426 $text = preg_replace( '/~{3,5}/', '', $text );
3427 $text = $this->replaceVariables( $text );
3433 * Set up some variables which are usually set up in parse()
3434 * so that an external function can call some class members with confidence
3437 function startExternalParse( &$title, $options, $outputType, $clearState = true ) {
3438 $this->mTitle
=& $title;
3439 $this->mOptions
= $options;
3440 $this->mOutputType
= $outputType;
3441 if ( $clearState ) {
3442 $this->clearState();
3447 * Transform a MediaWiki message by replacing magic variables.
3449 * @param string $text the text to transform
3450 * @param ParserOptions $options options
3451 * @return string the text with variables substituted
3454 function transformMsg( $text, $options ) {
3456 static $executing = false;
3458 $fname = "Parser::transformMsg";
3460 # Guard against infinite recursion
3466 wfProfileIn($fname);
3468 $this->mTitle
= $wgTitle;
3469 $this->mOptions
= $options;
3470 $this->mOutputType
= OT_MSG
;
3471 $this->clearState();
3472 $text = $this->replaceVariables( $text );
3475 wfProfileOut($fname);
3480 * Create an HTML-style tag, e.g. <yourtag>special text</yourtag>
3481 * The callback should have the following form:
3482 * function myParserHook( $text, $params, &$parser ) { ... }
3484 * Transform and return $text. Use $parser for any required context, e.g. use
3485 * $parser->getTitle() and $parser->getOptions() not $wgTitle or $wgOut->mParserOptions
3489 * @param mixed $tag The tag to use, e.g. 'hook' for <hook>
3490 * @param mixed $callback The callback function (and object) to use for the tag
3492 * @return The old value of the mTagHooks array associated with the hook
3494 function setHook( $tag, $callback ) {
3495 $oldVal = @$this->mTagHooks
[$tag];
3496 $this->mTagHooks
[$tag] = $callback;
3502 * Replace <!--LINK--> link placeholders with actual links, in the buffer
3503 * Placeholders created in Skin::makeLinkObj()
3504 * Returns an array of links found, indexed by PDBK:
3508 * $options is a bit field, RLH_FOR_UPDATE to select for update
3510 function replaceLinkHolders( &$text, $options = 0 ) {
3512 global $wgOutputReplace;
3514 $fname = 'Parser::replaceLinkHolders';
3515 wfProfileIn( $fname );
3519 $sk =& $this->mOptions
->getSkin();
3520 $linkCache =& LinkCache
::singleton();
3522 if ( !empty( $this->mLinkHolders
['namespaces'] ) ) {
3523 wfProfileIn( $fname.'-check' );
3524 $dbr =& wfGetDB( DB_SLAVE
);
3525 $page = $dbr->tableName( 'page' );
3526 $threshold = $wgUser->getOption('stubthreshold');
3529 asort( $this->mLinkHolders
['namespaces'] );
3533 foreach ( $this->mLinkHolders
['namespaces'] as $key => $ns ) {
3535 $title = $this->mLinkHolders
['titles'][$key];
3537 # Skip invalid entries.
3538 # Result will be ugly, but prevents crash.
3539 if ( is_null( $title ) ) {
3542 $pdbk = $pdbks[$key] = $title->getPrefixedDBkey();
3544 # Check if it's a static known link, e.g. interwiki
3545 if ( $title->isAlwaysKnown() ) {
3546 $colours[$pdbk] = 1;
3547 } elseif ( ( $id = $linkCache->getGoodLinkID( $pdbk ) ) != 0 ) {
3548 $colours[$pdbk] = 1;
3549 $this->mOutput
->addLink( $title, $id );
3550 } elseif ( $linkCache->isBadLink( $pdbk ) ) {
3551 $colours[$pdbk] = 0;
3553 # Not in the link cache, add it to the query
3554 if ( !isset( $current ) ) {
3556 $query = "SELECT page_id, page_namespace, page_title";
3557 if ( $threshold > 0 ) {
3558 $query .= ', page_len, page_is_redirect';
3560 $query .= " FROM $page WHERE (page_namespace=$ns AND page_title IN(";
3561 } elseif ( $current != $ns ) {
3563 $query .= ")) OR (page_namespace=$ns AND page_title IN(";
3568 $query .= $dbr->addQuotes( $this->mLinkHolders
['dbkeys'][$key] );
3573 if ( $options & RLH_FOR_UPDATE
) {
3574 $query .= ' FOR UPDATE';
3577 $res = $dbr->query( $query, $fname );
3579 # Fetch data and form into an associative array
3580 # non-existent = broken
3583 while ( $s = $dbr->fetchObject($res) ) {
3584 $title = Title
::makeTitle( $s->page_namespace
, $s->page_title
);
3585 $pdbk = $title->getPrefixedDBkey();
3586 $linkCache->addGoodLinkObj( $s->page_id
, $title );
3587 $this->mOutput
->addLink( $title, $s->page_id
);
3589 if ( $threshold > 0 ) {
3590 $size = $s->page_len
;
3591 if ( $s->page_is_redirect ||
$s->page_namespace
!= 0 ||
$size >= $threshold ) {
3592 $colours[$pdbk] = 1;
3594 $colours[$pdbk] = 2;
3597 $colours[$pdbk] = 1;
3601 wfProfileOut( $fname.'-check' );
3603 # Construct search and replace arrays
3604 wfProfileIn( $fname.'-construct' );
3605 $wgOutputReplace = array();
3606 foreach ( $this->mLinkHolders
['namespaces'] as $key => $ns ) {
3607 $pdbk = $pdbks[$key];
3608 $searchkey = "<!--LINK $key-->";
3609 $title = $this->mLinkHolders
['titles'][$key];
3610 if ( empty( $colours[$pdbk] ) ) {
3611 $linkCache->addBadLinkObj( $title );
3612 $colours[$pdbk] = 0;
3613 $this->mOutput
->addLink( $title, 0 );
3614 $wgOutputReplace[$searchkey] = $sk->makeBrokenLinkObj( $title,
3615 $this->mLinkHolders
['texts'][$key],
3616 $this->mLinkHolders
['queries'][$key] );
3617 } elseif ( $colours[$pdbk] == 1 ) {
3618 $wgOutputReplace[$searchkey] = $sk->makeKnownLinkObj( $title,
3619 $this->mLinkHolders
['texts'][$key],
3620 $this->mLinkHolders
['queries'][$key] );
3621 } elseif ( $colours[$pdbk] == 2 ) {
3622 $wgOutputReplace[$searchkey] = $sk->makeStubLinkObj( $title,
3623 $this->mLinkHolders
['texts'][$key],
3624 $this->mLinkHolders
['queries'][$key] );
3627 wfProfileOut( $fname.'-construct' );
3630 wfProfileIn( $fname.'-replace' );
3632 $text = preg_replace_callback(
3633 '/(<!--LINK .*?-->)/',
3634 "wfOutputReplaceMatches",
3637 wfProfileOut( $fname.'-replace' );
3640 # Now process interwiki link holders
3641 # This is quite a bit simpler than internal links
3642 if ( !empty( $this->mInterwikiLinkHolders
['texts'] ) ) {
3643 wfProfileIn( $fname.'-interwiki' );
3644 # Make interwiki link HTML
3645 $wgOutputReplace = array();
3646 foreach( $this->mInterwikiLinkHolders
['texts'] as $key => $link ) {
3647 $title = $this->mInterwikiLinkHolders
['titles'][$key];
3648 $wgOutputReplace[$key] = $sk->makeLinkObj( $title, $link );
3651 $text = preg_replace_callback(
3652 '/<!--IWLINK (.*?)-->/',
3653 "wfOutputReplaceMatches",
3655 wfProfileOut( $fname.'-interwiki' );
3658 wfProfileOut( $fname );
3663 * Replace <!--LINK--> link placeholders with plain text of links
3664 * (not HTML-formatted).
3665 * @param string $text
3668 function replaceLinkHoldersText( $text ) {
3669 $fname = 'Parser::replaceLinkHoldersText';
3670 wfProfileIn( $fname );
3672 $text = preg_replace_callback(
3673 '/<!--(LINK|IWLINK) (.*?)-->/',
3674 array( &$this, 'replaceLinkHoldersTextCallback' ),
3677 wfProfileOut( $fname );
3682 * @param array $matches
3686 function replaceLinkHoldersTextCallback( $matches ) {
3687 $type = $matches[1];
3689 if( $type == 'LINK' ) {
3690 if( isset( $this->mLinkHolders
['texts'][$key] ) ) {
3691 return $this->mLinkHolders
['texts'][$key];
3693 } elseif( $type == 'IWLINK' ) {
3694 if( isset( $this->mInterwikiLinkHolders
['texts'][$key] ) ) {
3695 return $this->mInterwikiLinkHolders
['texts'][$key];
3702 * Renders an image gallery from a text with one line per image.
3703 * text labels may be given by using |-style alternative text. E.g.
3704 * Image:one.jpg|The number "1"
3705 * Image:tree.jpg|A tree
3706 * given as text will return the HTML of a gallery with two images,
3707 * labeled 'The number "1"' and
3710 function renderImageGallery( $text ) {
3712 $parserOptions = new ParserOptions
;
3713 $localParser = new Parser();
3715 $ig = new ImageGallery();
3716 $ig->setShowBytes( false );
3717 $ig->setShowFilename( false );
3718 $lines = explode( "\n", $text );
3720 foreach ( $lines as $line ) {
3721 # match lines like these:
3722 # Image:someimage.jpg|This is some image
3723 preg_match( "/^([^|]+)(\\|(.*))?$/", $line, $matches );
3725 if ( count( $matches ) == 0 ) {
3728 $nt =& Title
::newFromText( $matches[1] );
3729 if( is_null( $nt ) ) {
3730 # Bogus title. Ignore these so we don't bomb out later.
3733 if ( isset( $matches[3] ) ) {
3734 $label = $matches[3];
3739 $pout = $localParser->parse( $label , $this->mTitle
, $parserOptions );
3740 $html = $pout->getText();
3742 $ig->add( new Image( $nt ), $html );
3743 $this->mOutput
->addImage( $nt->getDBkey() );
3745 return $ig->toHTML();
3749 * Parse image options text and use it to make an image
3751 function makeImage( &$nt, $options ) {
3752 global $wgUseImageResize;
3756 # Check if the options text is of the form "options|alt text"
3758 # * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
3759 # * left no resizing, just left align. label is used for alt= only
3760 # * right same, but right aligned
3761 # * none same, but not aligned
3762 # * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
3763 # * center center the image
3764 # * framed Keep original image size, no magnify-button.
3766 $part = explode( '|', $options);
3768 $mwThumb =& MagicWord
::get( MAG_IMG_THUMBNAIL
);
3769 $mwManualThumb =& MagicWord
::get( MAG_IMG_MANUALTHUMB
);
3770 $mwLeft =& MagicWord
::get( MAG_IMG_LEFT
);
3771 $mwRight =& MagicWord
::get( MAG_IMG_RIGHT
);
3772 $mwNone =& MagicWord
::get( MAG_IMG_NONE
);
3773 $mwWidth =& MagicWord
::get( MAG_IMG_WIDTH
);
3774 $mwCenter =& MagicWord
::get( MAG_IMG_CENTER
);
3775 $mwFramed =& MagicWord
::get( MAG_IMG_FRAMED
);
3778 $width = $height = $framed = $thumb = false;
3779 $manual_thumb = '' ;
3781 foreach( $part as $key => $val ) {
3782 if ( $wgUseImageResize && ! is_null( $mwThumb->matchVariableStartToEnd($val) ) ) {
3784 } elseif ( ! is_null( $match = $mwManualThumb->matchVariableStartToEnd($val) ) ) {
3785 # use manually specified thumbnail
3787 $manual_thumb = $match;
3788 } elseif ( ! is_null( $mwRight->matchVariableStartToEnd($val) ) ) {
3789 # remember to set an alignment, don't render immediately
3791 } elseif ( ! is_null( $mwLeft->matchVariableStartToEnd($val) ) ) {
3792 # remember to set an alignment, don't render immediately
3794 } elseif ( ! is_null( $mwCenter->matchVariableStartToEnd($val) ) ) {
3795 # remember to set an alignment, don't render immediately
3797 } elseif ( ! is_null( $mwNone->matchVariableStartToEnd($val) ) ) {
3798 # remember to set an alignment, don't render immediately
3800 } elseif ( $wgUseImageResize && ! is_null( $match = $mwWidth->matchVariableStartToEnd($val) ) ) {
3801 wfDebug( "MAG_IMG_WIDTH match: $match\n" );
3802 # $match is the image width in pixels
3803 if ( preg_match( '/^([0-9]*)x([0-9]*)$/', $match, $m ) ) {
3804 $width = intval( $m[1] );
3805 $height = intval( $m[2] );
3807 $width = intval($match);
3809 } elseif ( ! is_null( $mwFramed->matchVariableStartToEnd($val) ) ) {
3815 # Strip bad stuff out of the alt text
3816 $alt = $this->replaceLinkHoldersText( $caption );
3817 $alt = Sanitizer
::stripAllTags( $alt );
3819 # Linker does the rest
3820 $sk =& $this->mOptions
->getSkin();
3821 return $sk->makeImageLinkObj( $nt, $caption, $alt, $align, $width, $height, $framed, $thumb, $manual_thumb );
3825 * Set a flag in the output object indicating that the content is dynamic and
3826 * shouldn't be cached.
3828 function disableCache() {
3829 $this->mOutput
->mCacheTime
= -1;
3833 * Callback from the Sanitizer for expanding items found in HTML attribute
3834 * values, so they can be safely tested and escaped.
3835 * @param string $text
3836 * @param array $args
3840 function attributeStripCallback( &$text, $args ) {
3841 $text = $this->replaceVariables( $text, $args );
3842 $text = $this->unstripForHTML( $text );
3846 function unstripForHTML( $text ) {
3847 $text = $this->unstrip( $text, $this->mStripState
);
3848 $text = $this->unstripNoWiki( $text, $this->mStripState
);
3856 function Title( $x = NULL ) { return wfSetVar( $this->mTitle
, $x ); }
3857 function Options( $x = NULL ) { return wfSetVar( $this->mOptions
, $x ); }
3858 function OutputType( $x = NULL ) { return wfSetVar( $this->mOutputType
, $x ); }
3864 function getTags() { return array_keys( $this->mTagHooks
); }
3870 * @package MediaWiki
3874 var $mText, # The output text
3875 $mLanguageLinks, # List of the full text of language links, in the order they appear
3876 $mCategories, # Map of category names to sort keys
3877 $mContainsOldMagic, # Boolean variable indicating if the input contained variables like {{CURRENTDAY}}
3878 $mCacheTime, # Time when this object was generated, or -1 for uncacheable. Used in ParserCache.
3879 $mVersion, # Compatibility check
3880 $mTitleText, # title text of the chosen language variant
3881 $mLinks, # 2-D map of NS/DBK to ID for the links in the document. ID=zero for broken.
3882 $mTemplates, # 2-D map of NS/DBK to ID for the template references. ID=zero for broken.
3883 $mImages, # DB keys of the images used, in the array key only
3884 $mExternalLinks; # External link URLs, in the key only
3886 function ParserOutput( $text = '', $languageLinks = array(), $categoryLinks = array(),
3887 $containsOldMagic = false, $titletext = '' )
3889 $this->mText
= $text;
3890 $this->mLanguageLinks
= $languageLinks;
3891 $this->mCategories
= $categoryLinks;
3892 $this->mContainsOldMagic
= $containsOldMagic;
3893 $this->mCacheTime
= '';
3894 $this->mVersion
= MW_PARSER_VERSION
;
3895 $this->mTitleText
= $titletext;
3896 $this->mLinks
= array();
3897 $this->mTemplates
= array();
3898 $this->mImages
= array();
3899 $this->mExternalLinks
= array();
3902 function getText() { return $this->mText
; }
3903 function getLanguageLinks() { return $this->mLanguageLinks
; }
3904 function getCategoryLinks() { return array_keys( $this->mCategories
); }
3905 function &getCategories() { return $this->mCategories
; }
3906 function getCacheTime() { return $this->mCacheTime
; }
3907 function getTitleText() { return $this->mTitleText
; }
3908 function &getLinks() { return $this->mLinks
; }
3909 function &getTemplates() { return $this->mTemplates
; }
3910 function &getImages() { return $this->mImages
; }
3911 function &getExternalLinks() { return $this->mExternalLinks
; }
3913 function containsOldMagic() { return $this->mContainsOldMagic
; }
3914 function setText( $text ) { return wfSetVar( $this->mText
, $text ); }
3915 function setLanguageLinks( $ll ) { return wfSetVar( $this->mLanguageLinks
, $ll ); }
3916 function setCategoryLinks( $cl ) { return wfSetVar( $this->mCategories
, $cl ); }
3917 function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic
, $com ); }
3918 function setCacheTime( $t ) { return wfSetVar( $this->mCacheTime
, $t ); }
3919 function setTitleText( $t ) { return wfSetVar ($this->mTitleText
, $t); }
3921 function addCategory( $c, $sort ) { $this->mCategories
[$c] = $sort; }
3922 function addImage( $name ) { $this->mImages
[$name] = 1; }
3923 function addLanguageLink( $t ) { $this->mLanguageLinks
[] = $t; }
3924 function addExternalLink( $url ) { $this->mExternalLinks
[$url] = 1; }
3926 function addLink( $title, $id ) {
3927 $ns = $title->getNamespace();
3928 $dbk = $title->getDBkey();
3929 if ( !isset( $this->mLinks
[$ns] ) ) {
3930 $this->mLinks
[$ns] = array();
3932 $this->mLinks
[$ns][$dbk] = $id;
3935 function addTemplate( $title, $id ) {
3936 $ns = $title->getNamespace();
3937 $dbk = $title->getDBkey();
3938 if ( !isset( $this->mTemplates
[$ns] ) ) {
3939 $this->mTemplates
[$ns] = array();
3941 $this->mTemplates
[$ns][$dbk] = $id;
3948 function merge( $other ) {
3949 $this->mLanguageLinks = array_merge( $this->mLanguageLinks, $other->mLanguageLinks );
3950 $this->mCategories = array_merge( $this->mCategories, $this->mLanguageLinks );
3951 $this->mContainsOldMagic = $this->mContainsOldMagic || $other->mContainsOldMagic;
3955 * Return true if this cached output object predates the global or
3956 * per-article cache invalidation timestamps, or if it comes from
3957 * an incompatible older version.
3959 * @param string $touched the affected article's last touched timestamp
3963 function expired( $touched ) {
3964 global $wgCacheEpoch;
3965 return $this->getCacheTime() == -1 ||
// parser says it's uncacheable
3966 $this->getCacheTime() < $touched ||
3967 $this->getCacheTime() <= $wgCacheEpoch ||
3968 !isset( $this->mVersion
) ||
3969 version_compare( $this->mVersion
, MW_PARSER_VERSION
, "lt" );
3974 * Set options of the Parser
3976 * @package MediaWiki
3980 # All variables are private
3981 var $mUseTeX; # Use texvc to expand <math> tags
3982 var $mUseDynamicDates; # Use DateFormatter to format dates
3983 var $mInterwikiMagic; # Interlanguage links are removed and returned in an array
3984 var $mAllowExternalImages; # Allow external images inline
3985 var $mAllowExternalImagesFrom; # If not, any exception?
3986 var $mSkin; # Reference to the preferred skin
3987 var $mDateFormat; # Date format index
3988 var $mEditSection; # Create "edit section" links
3989 var $mNumberHeadings; # Automatically number headings
3990 var $mAllowSpecialInclusion; # Allow inclusion of special pages
3991 var $mTidy; # Ask for tidy cleanup
3993 function getUseTeX() { return $this->mUseTeX
; }
3994 function getUseDynamicDates() { return $this->mUseDynamicDates
; }
3995 function getInterwikiMagic() { return $this->mInterwikiMagic
; }
3996 function getAllowExternalImages() { return $this->mAllowExternalImages
; }
3997 function getAllowExternalImagesFrom() { return $this->mAllowExternalImagesFrom
; }
3998 function &getSkin() { return $this->mSkin
; }
3999 function getDateFormat() { return $this->mDateFormat
; }
4000 function getEditSection() { return $this->mEditSection
; }
4001 function getNumberHeadings() { return $this->mNumberHeadings
; }
4002 function getAllowSpecialInclusion() { return $this->mAllowSpecialInclusion
; }
4003 function getTidy() { return $this->mTidy
; }
4005 function setUseTeX( $x ) { return wfSetVar( $this->mUseTeX
, $x ); }
4006 function setUseDynamicDates( $x ) { return wfSetVar( $this->mUseDynamicDates
, $x ); }
4007 function setInterwikiMagic( $x ) { return wfSetVar( $this->mInterwikiMagic
, $x ); }
4008 function setAllowExternalImages( $x ) { return wfSetVar( $this->mAllowExternalImages
, $x ); }
4009 function setAllowExternalImagesFrom( $x ) { return wfSetVar( $this->mAllowExternalImagesFrom
, $x ); }
4010 function setDateFormat( $x ) { return wfSetVar( $this->mDateFormat
, $x ); }
4011 function setEditSection( $x ) { return wfSetVar( $this->mEditSection
, $x ); }
4012 function setNumberHeadings( $x ) { return wfSetVar( $this->mNumberHeadings
, $x ); }
4013 function setAllowSpecialInclusion( $x ) { return wfSetVar( $this->mAllowSpecialInclusion
, $x ); }
4014 function setTidy( $x ) { return wfSetVar( $this->mTidy
, $x); }
4015 function setSkin( &$x ) { $this->mSkin
=& $x; }
4017 function ParserOptions() {
4019 $this->initialiseFromUser( $wgUser );
4023 * Get parser options
4026 function newFromUser( &$user ) {
4027 $popts = new ParserOptions
;
4028 $popts->initialiseFromUser( $user );
4032 /** Get user options */
4033 function initialiseFromUser( &$userInput ) {
4034 global $wgUseTeX, $wgUseDynamicDates, $wgInterwikiMagic, $wgAllowExternalImages;
4035 global $wgAllowExternalImagesFrom, $wgAllowSpecialInclusion;
4036 $fname = 'ParserOptions::initialiseFromUser';
4037 wfProfileIn( $fname );
4038 if ( !$userInput ) {
4040 $user->setLoaded( true );
4042 $user =& $userInput;
4045 $this->mUseTeX
= $wgUseTeX;
4046 $this->mUseDynamicDates
= $wgUseDynamicDates;
4047 $this->mInterwikiMagic
= $wgInterwikiMagic;
4048 $this->mAllowExternalImages
= $wgAllowExternalImages;
4049 $this->mAllowExternalImagesFrom
= $wgAllowExternalImagesFrom;
4050 wfProfileIn( $fname.'-skin' );
4051 $this->mSkin
=& $user->getSkin();
4052 wfProfileOut( $fname.'-skin' );
4053 $this->mDateFormat
= $user->getOption( 'date' );
4054 $this->mEditSection
= true;
4055 $this->mNumberHeadings
= $user->getOption( 'numberheadings' );
4056 $this->mAllowSpecialInclusion
= $wgAllowSpecialInclusion;
4057 $this->mTidy
= false;
4058 wfProfileOut( $fname );
4063 * Callback function used by Parser::replaceLinkHolders()
4064 * to substitute link placeholders.
4066 function &wfOutputReplaceMatches( $matches ) {
4067 global $wgOutputReplace;
4068 return $wgOutputReplace[$matches[1]];
4072 * Return the total number of articles
4074 function wfNumberOfArticles() {
4075 global $wgNumberOfArticles;
4078 return $wgNumberOfArticles;
4082 * Return the number of files
4084 function wfNumberOfFiles() {
4085 $fname = 'Parser::wfNumberOfFiles';
4087 wfProfileIn( $fname );
4088 $dbr =& wfGetDB( DB_SLAVE
);
4089 $res = $dbr->selectField('image', 'COUNT(*)', array(), $fname );
4090 wfProfileOut( $fname );
4096 * Get various statistics from the database
4099 function wfLoadSiteStats() {
4100 global $wgNumberOfArticles, $wgTotalViews, $wgTotalEdits;
4101 $fname = 'wfLoadSiteStats';
4103 if ( -1 != $wgNumberOfArticles ) return;
4104 $dbr =& wfGetDB( DB_SLAVE
);
4105 $s = $dbr->selectRow( 'site_stats',
4106 array( 'ss_total_views', 'ss_total_edits', 'ss_good_articles' ),
4107 array( 'ss_row_id' => 1 ), $fname
4110 if ( $s === false ) {
4113 $wgTotalViews = $s->ss_total_views
;
4114 $wgTotalEdits = $s->ss_total_edits
;
4115 $wgNumberOfArticles = $s->ss_good_articles
;
4121 * Basically replacing " > and < with HTML entities ( ", >, <)
4123 * @param string $in Text that might contain HTML tags
4124 * @return string Escaped string
4126 function wfEscapeHTMLTagsOnly( $in ) {
4128 array( '"', '>', '<' ),
4129 array( '"', '>', '<' ),